Таблица файлов

Введение

Таблица файлов предназначена для хранения метаданных файлов, таких как имя файла, расширение, размер, MIME-тип, путь, URL, адрес предварительного просмотра, место хранения и пользовательские meta. Сам файл сохраняется движком файлового хранилища, а таблица файлов хранит метаданные файла.

Таблицу файлов можно создать только через страницу основной базы данных. Внешние базы данных, источники данных REST API и внешние источники данных NocoBase не поддерживают создание таблиц файлов.

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

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

  • Вложения к договорам, счета-фактуры, документы для подтверждения расходов
  • Изображения продуктов, удостоверения сотрудников, проектная документация
  • Файлы, загружаемые в бизнес-записи, файлы для предварительного просмотра и скачивания
  • Библиотека вложений, требующая отдельного управления метаданными файлов

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

Таблица файлов обычно не используется непосредственно как основная бизнес-таблица. Типичный процесс выглядит так:

  1. Создайте таблицу файлов для хранения заголовка файла, имени файла, размера, типа, URL, места хранения и других метаданных.
  2. Создайте в бизнес-таблице поле связи с таблицей файлов. Например, свяжите таблицу «Договоры» с таблицей файлов «Вложения к договорам».
  3. Добавьте поле связи в блок формы бизнес-таблицы, чтобы пользователи могли загружать файлы при создании или редактировании бизнес-записей.
  4. После завершения загрузки NocoBase записывает метаданные файла в таблицу файлов и связывает запись о файле с текущей бизнес-записью через поле связи.
  5. Отображайте поле вложений в блоке подробностей, табличном блоке или блоке списка бизнес-таблицы, чтобы пользователи могли просматривать, открывать предварительный просмотр или скачивать файлы.

Настройка создания

В основной базе данных нажмите «Create collection» и выберите «File collection», чтобы создать таблицу файлов.

20240324090414

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

НастройкаОписание
Collection display nameНазвание таблицы, отображаемое в интерфейсе, например «Вложения к договорам», «Счета-фактуры», «Изображения продуктов».
Collection nameИдентификационное имя таблицы, используемое для внутренних ссылок в API, полях связи, разрешениях, рабочих процессах и т. д.
CategoriesКатегория таблицы. Категория влияет только на организацию интерфейса управления таблицами и не изменяет структуру таблицы.
DescriptionОписание таблицы. Здесь можно указать, какие файлы хранит эта таблица, кто их загружает и с какими бизнес-таблицами они связаны.
Preset fieldsПредустановленные поля. При создании таблицы файлов рекомендуется сохранить системные поля и встроенные поля таблицы файлов.

Встроенные поля

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

ПолеИмя поляОписание
IDidПоле первичного ключа по умолчанию, используемое для уникальной идентификации записи о файле.
TitletitleЗаголовок файла, обычно отображаемый в интерфейсе.
File namefilenameИмя файла.
Extension nameextnameРасширение файла.
SizesizeРазмер файла.
MIME typemimetypeMIME-тип файла.
PathpathПуть к файлу в хранилище.
URLurlАдрес доступа к файлу.
PreviewpreviewАдрес предварительного просмотра файла.
Storagestorage / storageIdХранилище, которому принадлежит файл. storage — поле связи, а storageId — соответствующий внешний ключ.
MetametaРасширенные метаданные файла.
Время созданияcreatedAtАвтоматически записывает время создания записи о файле.
СоздательcreatedByПользователь, загрузивший файл или создавший запись о файле; записывается автоматически.
Время обновленияupdatedAtАвтоматически записывает время последнего обновления записи о файле.
ОбновилupdatedByПользователь, последним обновивший запись о файле; записывается автоматически.
ПространствоspaceДоступно после включения плагина нескольких пространств и используется для изоляции данных по пространствам. При отключённой функции нескольких пространств это поле не отображается.

20240324090527

Поле первичного ключа

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

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

Создание связи

Создайте в бизнес-таблице поле связи с таблицей файлов.

20240324091529

Использование в настройках страницы

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

20260710160424

20240324091321

Место настройкиНазначение
Блок формыЗагрузка вложений в записи бизнес-таблицы.
Блок подробностейОтображение, предварительный просмотр или скачивание вложений.
Табличный блокОтображение поля вложений в списке.
Блок связиНепосредственное управление записями о файлах, связанными с текущей бизнес-записью.

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

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

Поля метаданных файлов обычно заполняются автоматически в процессе загрузки. Не рекомендуется изменять назначение таких полей, как url, path, storageId. Если необходимо расширить бизнес-информацию о файлах, можно добавить новые поля, например «Тип файла», «Этап», «В архиве».

Удаление таблицы данных

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

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

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

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

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