Внешние источники данных. Часть 3. Работа с процедурами и функциями внешних источников данных
Внешние источники данных. Часть 3
3. Работа с процедурами и функциями внешних источников данных
3.1. Общая информация
Состав языка запросов и системы компоновки данных предоставляет широкие возможности по обработки данных, но не включает в себя специфические возможности различных СУБД, к которым можно отнести функции, последовательности, хранимые процедуры и различные специфические конструкции СУБД. В тоже время, применение специфических возможностей СУБД может оказаться критически важным при работе с внешними источниками данных. В качестве примера можно привести объектную таблицу СУБД, ключ которой получается из последовательности. Функции и процедуры могут ничего не возвращать (процедура), а также возвращать одиночное значение или таблицу.
Для работы с такими объектами СУБД в «1С:Предприятии» существует понятие функции внешнего источника данных. Функции в «1С:Предприятии» могут быть следующих видов:
- Таблица вида выражение в реляционном источнике данных;
- Функция, которая не возвращает значения (процедура);
- Функция, которая возвращает какое-либо значение.
Любая из вышеописанных функций может принимать параметры, количество параметров может быть как фиксированным, так и переменным.
Функция внешнего источника данных может выступать как прослойкой между реальной функцией (или сохраненной процедурой) СУБД, так и явным образом описывать некоторую конструкцию, которая будет подставлена в выполняемый запрос.
Функции могут использоваться во встроенном языке, языке запросов и системе компоновки данных. Для функций можно указывать права доступа, регламентирующие использование этих функций.
3.2. Общая схема использования
Для того чтобы использовать функции внешних источников данных в системе на базе «1С:Предприятия», следует придерживаться следующей общей схемы:
● Изучить структуру внешнего источника данных и понять, какие функции, процедуры или конструкции на языке СУБД необходимы для работы алгоритмов или отчетов в 1С:Предприятии».
● Создать объект Внешние источники данных в конфигураторе и для него создать подчиненные функции. Это можно сделать с помощью специального помощника.
● Реализовать использование созданных объектов в прикладном решении.
● Выполнить настройку параметров подключения к внешнему источнику данных в той сети, где будет использоваться прикладное решение. Эти параметры могут отличаться от тех, которые использовались при загрузке структуры внешнего источника данных.
ПРИМЕЧАНИЕ. Параметры доступа к внешнему источнику данных, которые были заданы в конфигураторе, не будут использованы системой в режиме 1С:Предприятие.
3.3. Редактирование функций
3.3.1. Общая информация
Для работы с функциями внешних источников данных предназначена ветвь с именем соответствующего внешнего источника данных ветви Внешние источники данных – <Имя внешнего источника данных> – Функции дерева конфигурации. Определение внешнего источника данных состоит из следующих шагов:
1. Определение собственно внешнего источника данных;
2. Определение функций источника данных;
3. Если во внешнем источнике данных существуют процедуры, возвращающие таблицы, то необходимо также определить таблицы внешнего источника данных вида выражение.
При этом в конфигурации может быть описано меньшее количество функций и процедур, чем есть в реальной базе данных. Также можно написать некоторую функцию (на языке используемой СУБД), которая отсутствует в реальной базе данных. При этом надо учитывать следующие особенности:
● Если для функции (как объекта конфигурации) указано, что выражение возвращает значение, то:
● При использовании во встроенном языке – выражение подставляется в конструкцию select <выражение>.
● При использовании в языке запросов (и системе компоновки данных) – происходит замена вызова функции на собственно выражение.
● Если для функции (как объекта конфигурации) указано, что она не возвращает значение, то:
● При использовании во встроенном языке – в зависимости от СУБД, может использоваться либо вызов с использованием конструкции select <выражение>, либо будет использована управляющая последовательность ODBC call. В силу этого, не рекомендуется использование произвольного выражения для функции, не возвращающей значение, с целью максимальной совместимости с различными СУБД.
● При использовании в языке запросов (или системе компоновки данных) – не поддерживается.
Создание структуры внешнего источника данных возможно как в ручном режиме, так и при загрузке этой структуры с помощью специального конструктора.
3.3.2. Внешний источник данных
При создании внешнего источника данных следует указать его имя. Этот объект предназначен для идентификации функций при обращении.
Источник данных состоит из одной или нескольких функций, также возможна ситуация, когда во внешнем источнике данных располагаются таблицы-выражения.
Если объект внешнего источника данных служит исключительно для обращений к процедурам и функциям, то значение свойства Режим управления блокировкой данных не имеет смысла. Если для внешнего источника данных режим управления блокировок установлен в значение Автоматический и управляемый, то для каждой таблицы режим блокировок определяется значением соответствующего свойства таблицы. Если для
внешнего источника данных выбран определенный конкретный режим управления блокировками, то одноименное свойство таблицы внешнего источника данных игнорируется.
3.3.3. Функция внешнего источника данных
При создании новой функции открывается окно конструктора функции внешнего источника данных. Если выбран ручной режим создания – будет открыта палитра свойств созданной функции внешнего источника данных .
Свойство функции Имя служит для идентификации функции при обращении к ней. Свойство Выражение в источнике данных будет содержать в себе выражение, которое будет использоваться в реальном запросе в базе данных при использовании функции. В данном свойстве можно указать не только обращение к реальной функции или сохраненной процедуры базы данных, но и написать выражение на языке СУБД внешнего источника данных.
Свойство Возвращает значение фактически указывает, что описывается в объекте конфигурации:
● Истина – описывается функция или выражение, возвращающее значение. В этом случае также необходимо указать, какого типа значение
будет возвращаться данным выражением.
● Ложь – процедура или выражение, не возвращающее значение.
Процедура или функция может принимать параметры. Функцией может выступать выражение на языке СУБД, например функция, которое получает следующее значение последовательности (SimpleSequence), будет иметь следующий вид:
NEXT VALUE FOR dbo.SimpleSequence
Если нужно получить следующее значение последовательности из встроенного языка, то это будет выглядеть следующим образом:
ЗначениеКлюча = ВнешниеИсточникиДанных.ВнешниеДанные.СледующееЗначениеКлюча();
В данном примере ВнешниеДанные – имя внешнего источника данных, в котором описана функция СледующееЗначениеКлюча(). Также функция может быть написана на языке используемой СУБД. При этом рекомендуется выражение заключать в круглые скобки, чтобы избежать различных побочных эффектов во время исполнения реального запроса. Следует помнить, что при трансформации запроса из языка запросов платформы «1С:Предприятие», в диалект SQL конкретной СУБД, функции подставляются непосредственно в текст получающегося запроса (с автоматической подстановкой параметров функций).
3.3.4. Таблица вида выражение внешнего источника данных
Функции могут возвращать не только значения, но и таблицы. В этом случае функцию необходимо создавать как таблицу вида выражение.
Действия, которые необходимо выполнить при создании таблицы внешнего источника данных. Также необходимо описать поля возвращаемых данных, аналогично обычным полям таблицы внешнего источника данных
3.3.5. Загрузка функций из внешнего источника данных
Существует возможность загрузки структуры таблиц из внешнего источника данных, который доступен для разработчика (например, копии реальной базы данных).
Для выполнения этой операции следует при создании таблицы указать пункт Выбрать из списка функций внешнего источника данных в конструкторе функции внешнего источника данных. Затем нужно указать строку соединения с внешней базой данных, воспользовавшись окном Подключение к источнику данных. При формировании строки подключения можно воспользоваться конструктором строки соединения с внешним
источником данных. Для этого следует нажать кнопку «…» справа от поля Строка соединения.
После того как подключение к внешней базе успешно выполнено, будет открыт список с перечнем процедур, функций и последовательностей подключенного источника данных. Затем следует выбрать те объекты, которые будут использованы конфигуратором для создания структуры объектов, описывающих текущий источник данных.
Имеется возможность указать, под каким именем функция будет создана в конфигурации «1С:Предприятия».
Если флажок Удалять из конфигурации функции, отсутствующие во внешнем источнике данных установлен, то при завершении работы конструктора функций из конфигурации будут удалены те функции, которые отсутствуют во внешнем источнике (например, во внешнем источнике функции были удалены) данных.
После нажатия кнопки Готово произойдет загрузка структуры функций внешнего источника данных.
3.3.6. Параметры функций внешнего источника данных
Формальные параметры функций внешнего источника данных описываются как &n, где n – номер параметра. Нумерация параметров начинается с 1. Если параметры являются необязательными, то параметры заключается в фигурные скобки ({}). Наличие необязательных параметров определяется каждый раз при фактическом вызове процедуры или функции. На место отсутствующих в необязательном блоке фактических параметров при вызове подставляется NULL (для каждого необязательного параметра).
// функция с двумя параметрами
dbo.uspGetWhereUsedProductID(&1, &2)
// функция в двумя необязательными параметрами
dbo.uspGetWhereUsedProductID(&1{, &2, &3})
Если процедура или функция может принимать переменное число параметров, то такая конструкция описывается как &n[]. В этом случае фактические параметры будут подставлены в выражение на место конструкции &n[] через запятую. Указание на возможность передачи переменного числа параметров может быть только последним в списке формальных параметров.
// функция, куда может быть передано от 2 до количества параметров,
// ограниченных используемой СУБД
dbo.uspGetWhereUsedProductID(&1, &2[])