ALTER FUNCTION

ALTER FUNCTION — изменить определение функции

Синтаксис

ALTER FUNCTION имя [ ( [ [ режим_аргумента ] [ имя_аргумента ] тип_аргумента [, ...] ] ) ]
    действие [ ... ] [ RESTRICT ]
ALTER FUNCTION имя [ ( [ [ режим_аргумента ] [ имя_аргумента ] тип_аргумента [, ...] ] ) ]
    RENAME TO новое_имя
ALTER FUNCTION имя [ ( [ [ режим_аргумента ] [ имя_аргумента ] тип_аргумента [, ...] ] ) ]
    OWNER TO { новый_владелец | CURRENT_ROLE | CURRENT_USER | SESSION_USER }
ALTER FUNCTION имя [ ( [ [ режим_аргумента ] [ имя_аргумента ] тип_аргумента [, ...] ] ) ]
    SET SCHEMA новая_схема
ALTER FUNCTION имя [ ( [ [ режим_аргумента ] [ имя_аргумента ] тип_аргумента [, ...] ] ) ]
    [ NO ] DEPENDS ON EXTENSION имя_расширения

где действием может быть:

    CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT
    IMMUTABLE | STABLE | VOLATILE
    [ NOT ] LEAKPROOF
    [ EXTERNAL ] SECURITY INVOKER | [ EXTERNAL ] SECURITY DEFINER
    PARALLEL { UNSAFE | RESTRICTED | SAFE }
    COST стоимость_выполнения
    ROWS строк_в_результате
    SUPPORT вспомогательная_функция
    SET параметр_конфигурации { TO | = } { значение | DEFAULT }
    SET параметр_конфигурации FROM CURRENT
    RESET параметр_конфигурации
    RESET ALL

Описание

Команда ALTER FUNCTION изменяет определение функции.

Чтобы использовать команду ALTER FUNCTION, нужно быть владельцем соответствующей функции. Чтобы изменить схему функции, необходимо помимо этого иметь право CREATE в новой схеме. Для смены владельца нужно иметь возможность выполнять SET ROLE для новой роли-владельца, и эта роль должна иметь право CREATE в схеме функции. (Эти ограничения направлены на то, чтобы при смене владельца не происходило ничего, что нельзя было бы сделать путем удаления и повторного создания функции. Однако суперпользователь все равно может сменить владельца любой функции.)

Параметры

имя

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

режим_аргумента

Режим аргумента: IN (входной), OUT (выходной), INOUT (входной-выходной) или VARIADIC (переменный). Если этот параметр опущен, по умолчанию установлен режим IN. Обратите внимание, что ALTER FUNCTION фактически не обращает никакого внимания на аргументы OUT, так как для идентификации функции нужны только входные аргументы. Поэтому достаточно перечислить аргументы IN, INOUT и VARIADIC.

имя_аргумента

Имя аргумента. Обратите внимание, что ALTER FUNCTION фактически не обращает никакого внимания на имена аргументов, так как для идентификации функции нужны только типы данных аргументов.

тип_аргумента

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

новое_имя

Новое имя функции.

новый_владелец

Новый владелец функции. Обратите внимание, что если функция помечена как SECURITY DEFINER, в дальнейшем она будет выполняться от имени нового владельца.

новая_схема

Новая схема для функции.

DEPENDS ON EXTENSION имя_расширения
NO DEPENDS ON EXTENSION имя_расширения

Эта форма помечает функцию как зависящую от расширения или, если указано NO, как более не зависящую от этого расширения. Функция, помеченная как зависящая от расширения, удаляется при удалении этого расширения, даже если не указано CASCADE. Функция может зависеть от нескольких расширений и будет удалена при удалении любого из них.

CALLED ON NULL INPUT
RETURNS NULL ON NULL INPUT
STRICT

CALLED ON NULL INPUT изменяет функцию таким образом, чтобы она вызывалась, когда некоторые или все ее аргументы равны NULL. RETURNS NULL ON NULL INPUT или STRICT изменяет функцию таким образом, чтобы она не вызывалась, если какой-либо из ее аргументов равен NULL, а вместо этого автоматически предполагался результат NULL. Дополнительную информацию см. на справочной странице команды CREATE FUNCTION.

IMMUTABLE
STABLE
VOLATILE

Меняет изменчивость функции на указанный вариант. Подробную информацию см. на справочной странице команды CREATE FUNCTION.

[EXTERNAL] SECURITY INVOKER
[EXTERNAL] SECURITY DEFINER

Устанавливает, является ли функция определяющей контекст безопасности. Ключевое слово EXTERNAL игнорируется для соответствия стандарту SQL. Дополнительную информацию об этой возможности см. на справочной странице команды CREATE FUNCTION.

PARALLEL

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

LEAKPROOF

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

COST стоимость_выполнения

Изменяет ожидаемую стоимость выполнения функции. Дополнительную информацию см. на справочной странице команды CREATE FUNCTION.

ROWS строк_в_результате

Изменяет ожидаемое число строк в результате функции, возвращающей множество. Дополнительную информацию см. на справочной странице команды CREATE FUNCTION.

SUPPORT вспомогательная_функция

Устанавливает или меняет вспомогательную функцию планировщика, которая будет использоваться с этой функцией. Подробную информацию см. в разделе Информация по оптимизации функций. Чтобы использовать эту функцию, нужно быть суперпользователем.
Этот параметр нельзя использовать для полного удаления вспомогательной функции, поскольку в нем следует указать имя новой вспомогательной функции. Если понадобится удалить такую функцию, воспользуйтесь CREATE OR REPLACE FUNCTION.

параметр_конфигурации
значение

Добавляет или изменяет установку параметра конфигурации, выполняемую при вызове функции. Если значение равно DEFAULT или использовано равнозначное указание RESET, локальное переопределение для функции удаляется, вследствие чего функция выполняется со значением, установленным в ее среде. Для удаления всех значений параметров этой функции укажите RESET ALL. SET FROM CURRENT сохраняет значение параметра, действующее в момент выполнения ALTER FUNCTION, в качестве значения, применяемого при последующих вызовов функции.
Подробную информацию о допустимых именах и значениях параметров см. на справочной странице команды SET и в главе Конфигурация сервера.

RESTRICT

Игнорируется для соответствия стандарту SQL.

Примеры

Переименование функции sqrt для типа integer в square_root:

ALTER FUNCTION sqrt(integer) RENAME TO square_root;

Смена владельца функции sqrt для типа integer на joe:

ALTER FUNCTION sqrt(integer) OWNER TO joe;

Замена схемы функции sqrt для типа integer на maths:

ALTER FUNCTION sqrt(integer) SET SCHEMA maths;

Обозначение функции sqrt для типа integer как зависимой от расширения mathlib:

ALTER FUNCTION sqrt(integer) DEPENDS ON EXTENSION mathlib;

Изменение пути поиска, который устанавливается для функции автоматически:

ALTER FUNCTION check_password(text) SET search_path = admin, pg_temp;

Отмена автоматического определения search_path для функции:

ALTER FUNCTION check_password(text) RESET search_path;

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

Совместимость

Эта команда частично схожа с командой ALTER FUNCTION в стандарте SQL. Стандарт позволяет менять больше свойств функции, но не предоставляет возможности переименовывать функцию, сделать функцию определяющей контекст безопасности, связывать с функцией значения параметров конфигурации или менять владельца, схему и тип изменчивости функции. Кроме того, стандарт SQL требует наличия ключевого слова RESTRICT, тогда как в QHB оно необязательно.

См. также

CREATE FUNCTION, DROP FUNCTION, ALTER PROCEDURE, ALTER ROUTINE