49.37. pg_proc
В каталоге pg_proc хранится информация о функциях (или процедурах). За дополнительными сведениями обратитесь к описанию CREATE FUNCTION и Разделу 35.3.
В этой таблице содержатся данные и агрегатных, и обычных функций. Если признак proisagg равен true, для этой функции должна быть ещё строка в pg_aggregate.
Таблица 49.37. Столбцы pg_proc
| Имя | Тип | Ссылки | Описание |
|---|---|---|---|
oid | oid | Идентификатор строки (скрытый атрибут; должен выбираться явно) | |
proname | name | Имя функции | |
pronamespace | oid | | OID пространства имён, содержащего эту функцию |
proowner | oid | | Владелец функции |
prolang | oid | | Язык реализации или интерфейс вызова для этой функции |
procost | float4 | Примерная стоимость выполнения (в единицах cpu_operator_cost); если установлен признак proretset, это стоимость выдачи одной строки | |
prorows | float4 | Примерное число возвращаемых строк (ноль, если признак proretset не установлен) | |
provariadic | oid | | Тип данных элементов переменного массива параметров, либо 0, если функция не принимает переменное число параметров |
protransform | regproc | | Вызовы этой функции могут быть упрощены заданной функцией (см. Подраздел 35.9.11) |
proisagg | bool | Функция является агрегатной | |
proiswindow | bool | Функция является оконной | |
prosecdef | bool | Функция определяет контекст безопасности (т. е. это функция «setuid») | |
proleakproof | bool | Функция не имеет побочных эффектов. Никакая информация о её аргументах не выдаётся, кроме как через возвращаемое значение. Любая функция, которая может выдать ошибку, в зависимости от значений аргументов, не является герметичной. | |
proisstrict | bool | Функция возвращает NULL, если любой из аргументов при вызове NULL. В этом случае функция фактически не будет вызываться вовсе. Функции, не являющиеся «строгими», должны быть готовы принять значения NULL. | |
proretset | bool | Функция возвращает множество (т. е. множество значений указанного типа данных) | |
provolatile | char | Свойство provolatile говорит, зависит ли результат функции только от её входных аргументов, либо на него влияют внешние факторы. Буквой i обозначаются постоянные функции («immutable»), которые всегда возвращают один результат для одних и тех же аргументов. Буквой s обозначаются стабильные функции («stable»), результаты которых (для одних и тех же аргументов) не меняются в ходе одного сканирования. Буквой v обозначаются изменчивые функции («volatile»), результаты которых могут меняться в любое время. (Так же v следует выбирать для функций с побочными эффектами, чтобы система не оптимизировала их вызовы.) | |
pronargs | int2 | Число входных аргументов | |
pronargdefaults | int2 | Число аргументов, для которых определены значения по умолчанию | |
prorettype | oid | | Тип данных возвращаемого значения |
proargtypes | oidvector | | Массив с типами данных аргументов функции. В нём учитываются только входные аргументы функции (включая аргументы INOUT и VARIADIC), так что он представляет сигнатуру вызова функции. |
proallargtypes | oid[] | | Массив с типами данных аргументов функции. В нём учитываются все аргументы (включая аргументы OUT и INOUT); однако, если все аргументы только входные (IN), это поле будет содержать NULL. Заметьте, что индексы в нём начинаются с 1, тогда как в proargtypes по историческим причинами они начинаются с 0. |
proargmodes | char[] | Массив с режимами аргументов функций, закодированными как i для входных аргументов (IN), o для выходных аргументов (OUT), b для аргументов входных и выходных одновременно (INOUT), v для переменных аргументов (VARIADIC) и t для табличных аргументов (TABLE). Если все аргументы являются аргументами IN, это поле может содержать NULL. Заметьте, что индексы в этом массиве соответствуют позициям в proallargtypes, а не в proargtypes. | |
proargnames | text[] | Массив с именами аргументов функции. Для аргументов без имени в этом массиве задаются пустые строки. Если все аргументы функции безымянные, это поле может содержать NULL. Заметьте, что индексы в этом массиве соответствуют позициям в proallargtypes, а не в proargtypes. | |
proargdefaults | pg_node_tree | Деревья выражений (в представлении nodeToString()) для значений аргументов по умолчанию. Это список, содержащий pronargdefaults элементов, соответствующих последним N входным аргументам (т. е., последним N позициям в proargtypes). Если значение по умолчанию не имеет никакой аргумент, это поле может содержать NULL. | |
protrftypes | oid[] | OID типов данных, к которым будут применяться трансформации. | |
prosrc | text | Это значение говорит обработчику функции, как вызывать данную функцию. Это может быть собственно исходный код функции для интерпретируемых языков, объектный символ, имя файла или что-то другое, в зависимости от языка реализации/соглашения о вызовах. | |
probin | text | Дополнительная информация о том, как вызывать функцию. Интерпретация этого значения так же зависит от языка. | |
proconfig | text[] | Локальные присвоения конфигурационных переменных времени выполнения, действующие в рамках функции | |
proacl | aclitem[] | Права доступа; за подробностями обратитесь к описанию GRANT и REVOKE |
Для скомпилированных функций, как встроенных, так и динамически загружаемых, поле prosrc содержит имя функции на языке C (объектный символ). Для всех других известных сегодня типов языков поле prosrc содержит исходный код функции. Поле probin используется только для динамически загружаемых функций на C, для которых оно задаёт имя разделяемой библиотеки, содержащей эти функции.
49.37. pg_proc
The catalog pg_proc stores information about functions (or procedures). See CREATE FUNCTION and Section 35.3 for more information.
The table contains data for aggregate functions as well as plain functions. If proisagg is true, there should be a matching row in pg_aggregate.
Table 49.37. pg_proc Columns
| Name | Type | References | Description |
|---|---|---|---|
oid | oid | Row identifier (hidden attribute; must be explicitly selected) | |
proname | name | Name of the function | |
pronamespace | oid | | The OID of the namespace that contains this function |
proowner | oid | | Owner of the function |
prolang | oid | | Implementation language or call interface of this function |
procost | float4 | Estimated execution cost (in units of cpu_operator_cost); if proretset, this is cost per row returned | |
prorows | float4 | Estimated number of result rows (zero if not proretset) | |
provariadic | oid | | Data type of the variadic array parameter's elements, or zero if the function does not have a variadic parameter |
protransform | regproc | | Calls to this function can be simplified by this other function (see Section 35.9.11) |
proisagg | bool | Function is an aggregate function | |
proiswindow | bool | Function is a window function | |
prosecdef | bool | Function is a security definer (i.e., a “setuid” function) | |
proleakproof | bool | The function has no side effects. No information about the arguments is conveyed except via the return value. Any function that might throw an error depending on the values of its arguments is not leak-proof. | |
proisstrict | bool | Function returns null if any call argument is null. In that case the function won't actually be called at all. Functions that are not “strict” must be prepared to handle null inputs. | |
proretset | bool | Function returns a set (i.e., multiple values of the specified data type) | |
provolatile | char | provolatile tells whether the function's result depends only on its input arguments, or is affected by outside factors. It is i for “immutable” functions, which always deliver the same result for the same inputs. It is s for “stable” functions, whose results (for fixed inputs) do not change within a scan. It is v for “volatile” functions, whose results might change at any time. (Use v also for functions with side-effects, so that calls to them cannot get optimized away.) | |
pronargs | int2 | Number of input arguments | |
pronargdefaults | int2 | Number of arguments that have defaults | |
prorettype | oid | | Data type of the return value |
proargtypes | oidvector | | An array with the data types of the function arguments. This includes only input arguments (including INOUT and VARIADIC arguments), and thus represents the call signature of the function. |
proallargtypes | oid[] | | An array with the data types of the function arguments. This includes all arguments (including OUT and INOUT arguments); however, if all the arguments are IN arguments, this field will be null. Note that subscripting is 1-based, whereas for historical reasons proargtypes is subscripted from 0. |
proargmodes | char[] | An array with the modes of the function arguments, encoded as i for IN arguments, o for OUT arguments, b for INOUT arguments, v for VARIADIC arguments, t for TABLE arguments. If all the arguments are IN arguments, this field will be null. Note that subscripts correspond to positions of proallargtypes not proargtypes. | |
proargnames | text[] | An array with the names of the function arguments. Arguments without a name are set to empty strings in the array. If none of the arguments have a name, this field will be null. Note that subscripts correspond to positions of proallargtypes not proargtypes. | |
proargdefaults | pg_node_tree | Expression trees (in nodeToString() representation) for default values. This is a list with pronargdefaults elements, corresponding to the last N input arguments (i.e., the last N proargtypes positions). If none of the arguments have defaults, this field will be null. | |
protrftypes | oid[] | Data type OIDs for which to apply transforms. | |
prosrc | text | This tells the function handler how to invoke the function. It might be the actual source code of the function for interpreted languages, a link symbol, a file name, or just about anything else, depending on the implementation language/call convention. | |
probin | text | Additional information about how to invoke the function. Again, the interpretation is language-specific. | |
proconfig | text[] | Function's local settings for run-time configuration variables | |
proacl | aclitem[] | Access privileges; see GRANT and REVOKE for details |
For compiled functions, both built-in and dynamically loaded, prosrc contains the function's C-language name (link symbol). For all other currently-known language types, prosrc contains the function's source text. probin is unused except for dynamically-loaded C functions, for which it gives the name of the shared library file containing the function.
