SQL сценарий

Конфигурационный элемент типа SQL сценарий (SQL script) — это сущность, которая позволяет реализовать запрос к базе данных приложения с помощью языка SQL. Назначение SQL сценария — создание объектов (например, представлений, процедур, функций) базы данных или выполнение других запросов к базе данных приложения.

Конфигурационный элемент типа SQL сценарий (SQL script), который позволяет добавить Creatio IDE, представлен значением выпадающего списка Добавить (Add) панели инструментов рабочей области раздела Конфигурация (Configuration).

Подробнее о видах конфигурационных элементов читайте в статье Операции в Creatio IDE.

Конфигурационный элемент типа SQL сценарий (SQL script) представлен значением SQL сценарий (SQL script) выпадающего списка Тип (Type) панели инструментов рабочей области раздела Конфигурация (Configuration).

Тип SQL сценария представлен на рисунке ниже.

Подробнее о типах конфигурационных элементов читайте в статье Операции в Creatio IDE.

Реализовать SQL сценарий 

1. Перейдите в раздел Конфигурация (Configuration) и выберите пользовательский пакет, в который будет добавлен конфигурационный элемент.

2. На панели инструментов реестра раздела нажмите Добавить —> SQL сценарий (Add —> SQL script).

   

3. В дизайнере сценариев заполните свойства конфигурационного элемента.

   Основные свойства конфигурационного элемента:

   • Код (Code) — название конфигурационного элемента (обязательное свойство). Шаблон, который необходимо использовать для названия SQL сценария, приведен ниже.

     [Префикс][Операция][Объект][СУБД]
     

     UsrUpdateActivityDateMSSQL
     

     [Префикс] — префикс названия конфигурационного элемента (по умолчанию Usr), который указан в системной настройке Префикс названия объекта (Prefix for object name, код SchemaNamePrefix). Может содержать символы латинского алфавита и цифры. Наличие префикса и его совпадение со значением системной настройки проверяется при переходе к другому свойству конфигурационного элемента. Если он отсутствует или не совпадает, то пользователь получает соответствующее уведомление.

     [Операция] — операция, которую выполняет SQL сценарий. Возможные значения: Insert, Update, Delete. Для названия SQL сценария, который создает объект (значение Create), можно не указывать значение операции.

     [Объект] — объект, с которым взаимодействует SQL сценарий (обязательный параметр).

     [СУБД] — тип базы данных, для которой разрабатывается SQL сценарий (обязательный параметр). Совпадает со значением свойства Тип СУБД (DBMS type) SQL сценария.

   • Тип СУБД (DBMS type) — тип базы данных, для которой разрабатывается текущий сценарий (обязательное свойство). Возможные значения: "MSSql", "Oracle", "PostgreSql".

   • Тип установки (Installation type) — задает порядок выполнения сценария при установке пакета (обязательное свойство).

     Возможные значения:

     • "BeforePackage" — SQL сценарий необходимо выполнить перед установкой пакета.
     • "AfterPackage" — SQL сценарий необходимо выполнить после установки пакета.
     • "AfterSchemaData" — SQL сценарий необходимо выполнить после установки данных (конфигурационные элементы типа Данные (Data)) пакета.
     • "UninstallApp" — SQL сценарий, который выполняется при удалении из приложения пакета, которому принадлежит текущий SQL сценарий.
   • Пакет (Package) — пользовательский пакет, в котором создается конфигурационный элемент. Заполняется автоматически и недоступно для редактирования.
   

   Для применения изменений свойств нажмите Применить (Apply).

   Панель свойств дизайнера сценариев позволяет:

   • Изменить основные свойства конфигурационного элемента (кнопка ).
   • Задать дополнительные свойства конфигурационного элемента (кнопка ).

   Дополнительные свойства конфигурационного элемента:

   • Зависит от SQL сценариев (Depends on SQL Scripts) — позволяет выбрать SQL сценарии, которые необходимо выполнить до начала выполнения текущего сценария.
   • Зависимые SQL сценарии (Dependent SQL Scripts) — содержит SQL сценарии, выполнения которых необходимо начать после завершения выполнения текущего сценария. Заполняется автоматически и недоступно для редактирования.

   Чтобы выполнять SQL сценарии в установленном порядке:

   1. Выберите соответствующий тип установки (значение свойства Тип установки (Installation type)).
   2. Установите необходимые зависимости между сценариями (свойства Зависит от SQL сценариев (Depends on SQL Scripts) и Зависимые SQL сценарии (Dependent SQL Scripts)).
4. На панели инструментов дизайнера сценариев нажмите Проверка (Validation) для выполнения проверки синтаксиса SQL сценария.
5. На панели инструментов дизайнера сценариев нажмите Сохранить (Save) для сохранения изменений в метаданных конфигурационного элемента.