Перейти к содержимому

Документация Corta

Настройка хранения записей

Создание подключения для хранения записей

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

Чтобы хранить записи в другом подключении, сначала необходимо создать это подключение.

По умолчанию Corta сохраняет все записи (вместе с их значениями) в одной таблице, что подходит для большинства базовых сценариев. Если ваш сценарий не требует использования выделенного хранилища для записей, вы можете пропустить этот раздел.

Важно

Изменения в схеме базы данных, предлагаемые Corta, могут быть не оптимальными и могут изменяться в будущих версиях. Если вы хотите иметь полный контроль над структурой базы данных, рекомендуется вносить изменения вручную.

Настройка хранения записей

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

Вы можете выбрать один из следующих вариантов:

  • Автоматическое внесение изменений через Corta:
    Нажмите кнопку "Исправить" или "Исправить автоматически", чтобы автоматически применить предложенные изменения.

  • Внесение изменений вручную:
    Внесите изменения непосредственно в базе данных и отклоните предложение Corta, нажав кнопку "Отклонить".

Настройка конфигурации

Опции настройки хранения записей доступны на странице редактирования модуля во вкладке "Хранилище данных".

Настройка подключения для хранения записей

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

Важно

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

Подключение к базе данных

Подключение к базе данных определяет, какое соединение Corta будет использовать для обработки записей модуля. По умолчанию используется основное подключение.

Название коллекции или таблицы базы данных

Название коллекции или таблицы базы данных указывает, где в указанном подключении будут храниться записи модуля.

  • Если идентификатор не указан, используется идентификатор, заданный подключением.
  • Если подключение не предоставляет идентификатор по умолчанию, используется системный идентификатор compose_record.

В некоторых случаях Corta может автоматически создать необходимые структуры, если они отсутствуют в подключении (например, новую таблицу в реляционной базе данных).

Примечание для разработчиков:

Таблицы могут создаваться автоматически. Вы можете использовать следующие плейсхолдеры:

  • {{module}}: заменяется на имя модуля или его идентификатор, если имя не задано.
  • {{namespace}}: заменяется на имя пространства или его идентификатор, если имя не задано.

Отображение полей модуля

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

Отображение поля модуля

Флажок "Отображение поля модуля" позволяет включить или отключить сохранение значений поля. Если флажок не установлен, значения поля не будут сохраняться.

  • Рекомендуется сохранять все поля модуля.
  • Если поле больше не требуется, его следует удалить из определения модуля.

Кодек

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

Конфигурация кодека

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

Системные поля

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

Системные поля, как правило, содержат метаданные о записи. Если требуется, можно исключить определённые системные поля из хранения. Это может быть полезно при подключении к существующим базам данных, структура которых не поддерживает все системные поля.

Отображение поля модуля

Флажок "Отображение поля модуля" позволяет включить или отключить сохранение значений системных полей. Если флажок не установлен, значения поля не будут сохраняться.

  • Рекомендуется сохранять все системные поля.
  • Исключение системных полей, таких как id или временные метки, может привести к непредвиденному поведению. Рекомендуется сохранять все системные поля.

Кодек

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

Конфигурация кодека

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

Кодеки кодирования полей

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

JSON

Кодек JSON кодирует значение поля в формате JSON-объекта. Местоположение JSON-объекта (например, столбец таблицы) определяется идентификатором, указанным в конфигурации кодека.

Этот кодек используется по умолчанию для пользовательских полей модуля.

Подходит для случаев, когда требуется извлекать значения из JSON-объектов.

В текущей версии Corta поддерживает следующую структуру JSON (в будущих версиях планируется расширение гибкости):

{ "identifier": [ ... ] }
  • Идентификатор значения должен совпадать с именем поля модуля.
  • Поле может содержать одно или несколько значений, хранящихся в массиве.

Alias

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

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

Column

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

Этот кодек используется для системных полей модуля.

Подходит для случаев, когда значения хранятся в отдельном месте с идентификатором, совпадающим с именем поля модуля.

Устранение неполадок

Проблемы с модулем

Если модуль настроен некорректно или подключение сообщает об ошибках, список обнаруженных проблем отображается на экране редактирования модуля. В случае возникновения проблем появляется новая вкладка "Проблемы", где можно ознакомиться с их описанием и предложениями по устранению.

Навигация по документу