51.1. Создание функции #
В навигационной панели перейдите в Базы данных.
(Необязательно) Чтобы отобразить системные базы данных, активируйте переключатель Показывать системные базы данных.
Нажмите на имя базы данных.
Нажмите на имя схемы.
Выберите вкладку Функции.
В правом верхнем углу страницы нажмите Создать функцию.
Укажите параметры новой функции (помеченные звёздочкой параметры являются обязательными):
Имя.
Язык: процедурный язык функции.
Аргументы.
Чтобы добавить аргумент:
Нажмите Добавить аргумент +.
Укажите параметры нового аргумента (помеченные звёздочкой параметры являются обязательными):
Имя.
Режим аргумента.
Возможные значения:
IN
OUT
INOUT
VARIADIC
Тип: тип данных аргумента.
Значение по умолчанию: значение аргумента по умолчанию.
Функция возвращает таблицу: указывает, возвращает ли функция таблицу.
При активации этого переключателя добавьте возвращаемое значение:
Нажмите Добавить возвращаемое значение +.
Укажите параметры нового возвращаемого значения (помеченные звёздочкой параметры являются обязательными):
Имя.
Тип.
Тип возвращаемого значения: тип данных возвращаемого значения.
Этот параметр доступен, только если вы активировали переключатель Функция возвращает таблицу.
Тело функции: тело функции на выбранном процедурном языке.
Оконная функция: указывает, является ли функция оконной.
Параметры для планировщика: атрибут, который информирует оптимизатор запросов о поведении функции.
Возможные значения:
Default: значение по умолчанию — Volatile.
Immutable: функция является immutable (постоянной), не может модифицировать базу данных и всегда возвращает один и тот же результат при определённых значениях аргументов; то есть, она не обращается к базе данных и не использует информацию, не переданную ей явно в списке аргументов.
Если функция имеет такую характеристику, любой её вызов с аргументами-константами можно немедленно заменить значением функции.
Stable: функция является stable (стабильной), не может модифицировать базу данных и в рамках одного сканирования таблицы она всегда возвращает один и тот же результат для определённых значений аргументов, но этот результат может быть разным в разных операторах SQL.
Это подходящий выбор для функций, результаты которых зависят от содержимого и параметров базы данных, например текущего часового пояса. Однако этот вариант не подходит для триггеров
AFTER, которые пытаются прочитать строки, изменённые текущей командой.Примечание
Функции семейства
current_timestampтакже считаются стабильными, так как их результаты не меняются внутри транзакции.Volatile: функция является volatile (изменчивой), её результат может меняться даже в рамках одного сканирования таблицы, поэтому её вызовы невозможно оптимизировать.
Только некоторые функции являются изменчивыми, например
random(),currval()иtimeofday().Примечание
Любая функция с побочными эффектами должна классифицироваться как изменчивая, даже если её результат предсказуем, чтобы её вызовы не были оптимизированы. Примером такой функции является
setval().
Строгая обработка NULL значений: указывает, что функция всегда будет возвращать
NULL, если в одном из аргументов был переданNULL.Не имеет побочных эффектов: указывает, что функция не имеет побочных эффектов, так как не раскрывает информацию о своих аргументах, а только возвращает результат.
Параметры безопасности: права, с которыми будет вызываться и выполняться функция.
Возможные значения:
По умолчанию: значение по умолчанию — Invoker.
Invoker: функция будет выполняться с правами пользователя, вызвавшего её.
Definer: функция будет выполняться с правами пользователя, создавшего её.
Использование в параллельном режиме: параметры вызова функции в параллельном режиме.
Возможные значения:
По умолчанию: значение по умолчанию — Unsafe.
Unsafe: функцию нельзя выполнять в параллельном режиме и присутствие такой функции в операторе SQL приводит к выбору последовательного плана выполнения.
Restricted: функцию можно выполнять в параллельном режиме, но только в ведущем процессе группы.
Safe: функция безопасна для выполнения в параллельном режиме без ограничений, в том числе в параллельных рабочих процессах.
Таймаут при ожидании блокировки, с.: максимальная длительность ожидания получения блокировки таблицы, индекса, строки или другого объекта базы данных. Если ожидание не закончилось за указанное время, оператор прерывается. Это ограничение действует на каждую попытку получения блокировки по отдельности.
За подробной информацией об этом параметре обратитесь к официальной документации Postgres Pro.
Показать SQL: отображает SQL-запрос создания функции с заданными параметрами.
Нажмите Создать.
51.1. Creating a Function #
In the navigation panel, go to Databases.
(Optional) To display system databases, turn on Show system databases.
Click the name of the database.
Click the name of the schema.
Select Functions.
In the top-right corner of the page, click Create function.
Specify parameters of the new function (parameters marked with an asterisk are required):
Name.
Language: The procedural language of the function.
Arguments.
To add an argument:
Click Add argument +.
Specify parameters of the new argument (parameters marked with an asterisk are required):
Name.
Argument mode.
Possible values:
IN
OUT
INOUT
VARIADIC
Type: The argument data type.
Default value: The default value of the argument.
Function return table: Specifies whether the function returns a table.
If turn on this toggle, add a return value:
Click Add return value +.
Specify parameters of the new return value (parameters marked with an asterisk are required):
Name.
Type.
Return value type: The data type of the value that the function will return.
This parameter is available only if you turn off Function return table.
Function body: The body of the function in the selected procedural language.
Window: Specifies whether the function is a window function.
Optimizer: The attribute that informs the optimizer about the behavior of the function.
Possible values:
Default: The default value is Volatile.
Immutable: The function is immutable and it cannot modify the database and always returns the same result for specific arguments. It means that the function does not interact with the database and does not use the information that was not passed to the argument list.
If a function is immutable, any function call with constant arguments can be immediately replaced with the function value.
Stable: The function is stable and it cannot modify the database and always returns the same result for specific arguments within one table scan, but the result can differ for different SQL operators.
This is applicable to functions whose results depend on the database contents and parameters, such as time zone. However, this is not applicable to
AFTERtriggers that are trying to read the rows changed by the current command.Note
The
current_timestampfunctions are also considered stable, since their results do not change in the transaction.Volatile: The function is volatile and its result can change even within one table scan, so the function calls cannot be optimized.
Only a limited number of functions are volatile, for example,
random(),currval(), andtimeofday().Note
Any function that has side effects must be considered volatile even if its results are predictable so that its calls are not optimized. An example of such a function is
setval().
Strict: Specifies whether the function will always return
NULLifNULLis passed in one of the arguments.Leakproof: Specifies whether the function does not have any side effects and it does not reveal any information about its arguments and only returns the result.
Security: The privileges that will be used for calling and executing the function.
Possible values:
Default: The default value is Invoker.
Invoker: The function will be executed with the privileges of the user who called it.
Definer: The function will be executed with the privileges of the user who defined it.
Parallel: The parameters for calling the function in the parallel mode.
Possible values:
Default: The default value is Unsafe.
Unsafe: The function cannot be executed in the parallel mode and having such a function in an SQL operator will lead to selecting a sequential query plan.
Restricted: The function can be executed in the parallel mode, but only in the parallel group leader process.
Safe: The function can be safely executed in the parallel mode with no restrictions, including parallel worker processes.
lock_timeout, s: Abort any statement that waits longer than the specified time while attempting to acquire a lock on a table, index, row, or other database object. The time limit applies separately to each lock acquisition attempt.
For more information about this parameter, refer to the official Postgres Pro documentation.
Show SQL: Displays the SQL query for creating the function with the specified parameters.
Click Create.