Аргумент | Описание |
имя | Имя UDF для использования в операторах SQL. Может отличаться от имени, указанного после ключевого слова ENTRY POINT. Если вы используете существующую библиотеку, то хорошо бы изменить предоставляемое имя - хотя бы для того, чтобы устранить путаницу при объявлении той же функции с другими именами в других базах данных |
тип-данных | Тип данных для входного или возвращаемого параметра. Если аргументы не передаются по дескриптору, это тип данных включающего языка. Все входные параметры передаются в UDF по ссылке или по дескриптору. Возвращаемые параметры могут передаваться по ссылке, по значению или по дескриптору. Тип данных не может быть массивом или элементом массива |
RETURNS | Спецификация возвращаемого значения функции |
BY VALUE | Указывает, что возвращаемое значение должно передаваться по значению, а не по ссылке |
CSTRING( целое) | Указывает, что UDF возвращает значение в виде строки с нулевым терминатором с максимальной длиной целое байтов |
FREE_IT | Освобождает память возвращаемого значения после завершения выполнения UDF. Используйте это, только если память в UDF выделяется динамически с использованием функции ib_util_malloc, определенной в библиотеке ib_util. Библиотека ib_util должна находиться в каталоге /bin, чтобы вариант FKEE_IT мог работать |
RETURNS PARAMETER n | Указывает, что функция возвращает n-й входной параметр. Это требуется для возвращения типов данных BLOB |
точка-входа | Заключенная в апострофы строка, задающая имя, под которым UDF присутствует в исходном коде и сохранена в библиотеке UDF |
имя-модуля | Заключенная в апострофы спецификация файла, идентифицирующая библиотеку, которая содержит UDF |
Большинство библиотек внешних функций поставляется вместе с их собственными скриптами DDL, содержащими объявления для каждой функции и, обычно, некоторую краткую документацию. Существует соглашение именовать скрипт так же, как и библиотеку, но с использованием расширения файла SQL или sql. Однако не все общедоступные библиотеки придерживаются этого соглашения.
Скрипты ib udf.sql и fbudf.sql находятся в каталоге /UDF вашего каталога инсталляции сервера. Комплект FreeUDFLib содержит скрипт с именем extfuncs.sql. Вы можете свободно копировать и вставлять объявления для компоновки вашей собственной библиотеки из любимых объявлений.
Следующее объявление является примером из скрипта ib udf.sql:
DECLARE EXTERNAL FUNCTION ipad
CSTRING(80), INTEGER, CSTRING(1)
RETURNS CSTRING(80) FREE_IT
ENTRY_POINT 'IB_UDF_lpad' MODULE_NAME 'ib_udf';
Следующее объявление содержится в fbudf, оно передает аргументы по дескриптору в некоторые функции:
DECLARE EXTERNAL FUNCTION sright
VARCHAR(100) BY DESCRIPTOR, SMALLINT,
VARCHAR(100) RETURNS PARAMETER 3
ENTRY POINT 'right' MODULE_NAME 'fbudf';
При объявлении внешней функции для базы данных вы не ограничены использованием только имен, появляющихся в скрипте. Имя функции должно быть уникальным среди имен всех функций, объявленных в базе данных. Библиотеки общего использования обычно соответствуют соглашению о поставляемых объявлениях, по которому эти имена "не наступают на ноги" идентификаторам, обычно используемым в другой библиотеке, поэтому вы можете увидеть некоторые странности в именах в этих скриптах.