Postgres Pro Standard : Документация: 14: 51.38. pg_proc : Компания Postgres Professional

51.38. `pg_proc`
Пред.	Наверх	Глава 51. Системные каталоги	Начало	След.

51.38. `pg_proc`

В каталоге pg_proc хранится информация об обычных функциях, процедурах, агрегатных и оконных функциях (в совокупности также называемых подпрограммами). За дополнительными сведениями обратитесь к описанию CREATE FUNCTION, CREATE PROCEDURE и Разделу 37.3.

Если prokind указывает, что данная запись описывает агрегатную функцию, в pg_aggregate должна быть соответствующая строка.

Таблица 51.38. Столбцы pg_proc

Тип столбца Описание
`oid` `oid` Идентификатор строки
`proname` `name` Имя функции
`pronamespace` `oid` (ссылается на `pg_namespace`.`oid`) OID пространства имён, содержащего эту функцию
`proowner` `oid` (ссылается на `pg_authid`.`oid`) Владелец функции
`prolang` `oid` (ссылается на `pg_language`.`oid`) Язык реализации или интерфейс вызова для этой функции
`procost` `float4` Примерная стоимость выполнения (в единицах cpu_operator_cost); если установлен признак `proretset`, это стоимость выдачи одной строки
`prorows` `float4` Примерное число возвращаемых строк (ноль, если признак `proretset` не установлен)
`provariadic` `oid` (ссылается на `pg_type`.`oid`) Тип данных элементов переменного массива параметров, либо 0, если функция не принимает переменное число параметров
`prosupport` `regproc` (ссылается на `pg_proc`.`oid`) Вспомогательная функция планировщика для данной функции (см. Раздел 37.11) или ноль, если её нет
`prokind` `char` `f` — обычная функция (Function), `p` — процедура (Procedure), `a` — агрегатная функция (Aggregate function) или `w` — оконная функция (Window function)
`prosecdef` `bool` Функция определяет контекст безопасности (т. е. это функция «setuid»)
`proleakproof` `bool` Функция не имеет побочных эффектов. Никакая информация о её аргументах не выдаётся, кроме как через возвращаемое значение. Любая функция, которая может выдать ошибку, в зависимости от значений аргументов, не является герметичной.
`proisstrict` `bool` Функция возвращает NULL, если любой из аргументов при вызове NULL. В этом случае функция фактически не будет вызываться вовсе. Функции, не являющиеся «строгими», должны быть готовы принять значения NULL.
`proretset` `bool` Функция возвращает множество (т. е. множество значений указанного типа данных)
`provolatile` `char` Свойство `provolatile` говорит, зависит ли результат функции только от её входных аргументов, либо на него влияют внешние факторы. Буквой `i` обозначаются постоянные функции («immutable»), которые всегда возвращают один результат для одних и тех же аргументов. Буквой `s` обозначаются стабильные функции («stable»), результаты которых (для одних и тех же аргументов) не меняются в ходе одного сканирования. Буквой `v` обозначаются изменчивые функции («volatile»), результаты которых могут меняться в любое время. (Так же `v` следует выбирать для функций с побочными эффектами, чтобы система не оптимизировала их вызовы.)
`proparallel` `char` Свойство `proparallel` говорит, может ли эта функция безопасно выполняться в параллельном режиме. Символом `s` в нём обозначаются функции, которые могут выполняться в параллельном режиме без ограничений. Символом `r` обозначаются функции, которые могут выполняться в параллельном режиме, но только в ведущем процессе группы; в параллельных рабочих процессах вызывать их нельзя. Символом `u` отмечаются функции небезопасные в параллельном режиме; присутствие такой функции влечёт выбор последовательного плана выполнения запроса.
`pronargs` `int2` Число входных аргументов
`pronargdefaults` `int2` Число аргументов, для которых определены значения по умолчанию
`prorettype` `oid` (ссылается на `pg_type`.`oid`) Тип данных возвращаемого значения
`proargtypes` `oidvector` (ссылается на `pg_type`.`oid`) Массив типов аргументов функции. В нём учитываются только входные аргументы функции (включая аргументы `INOUT` и `VARIADIC`), так что он представляет сигнатуру вызова функции.
`proallargtypes` `oid[]` (ссылается на `pg_type`.`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[]` (ссылается на `pg_type`.`oid`) Массив типов аргументов/результатов, к которым должны применяться трансформации (заданные в предложении `TRANSFORM` объявления функции), либо NULL, если таковых нет.
`prosrc` `text` Это значение говорит обработчику функции, как вызывать данную функцию. Это может быть собственно исходный код функции для интерпретируемых языков, объектный символ, имя файла или что-то другое, в зависимости от языка реализации/соглашения о вызовах.
`probin` `text` Дополнительная информация о том, как вызывать функцию. Интерпретация этого значения так же зависит от языка.
`prosqlbody` `pg_node_tree` Предварительно разобранное тело SQL-функции. Используется для функций на языке SQL, когда тело функции оформлено по стандарту SQL, а не в виде строки. В других случаях — NULL.
`proconfig` `text[]` Локальные присваивания конфигурационных переменных времени выполнения, действующие в рамках функции
`proacl` `aclitem[]` Права доступа; за подробностями обратитесь к Разделу 5.7.

Тип столбца

Описание

oid oid

Идентификатор строки

proname name

Имя функции

pronamespace oid (ссылается на pg_namespace.oid)

OID пространства имён, содержащего эту функцию

proowner oid (ссылается на pg_authid.oid)

Владелец функции

prolang oid (ссылается на pg_language.oid)

Язык реализации или интерфейс вызова для этой функции

procost float4

Примерная стоимость выполнения (в единицах cpu_operator_cost); если установлен признак proretset, это стоимость выдачи одной строки

prorows float4

Примерное число возвращаемых строк (ноль, если признак proretset не установлен)

provariadic oid (ссылается на pg_type.oid)

Тип данных элементов переменного массива параметров, либо 0, если функция не принимает переменное число параметров

prosupport regproc (ссылается на pg_proc.oid)

Вспомогательная функция планировщика для данной функции (см. Раздел 37.11) или ноль, если её нет

prokind char

f — обычная функция (Function), p — процедура (Procedure), a — агрегатная функция (Aggregate function) или w — оконная функция (Window function)

prosecdef bool

Функция определяет контекст безопасности (т. е. это функция «setuid»)

proleakproof bool

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

proisstrict bool

Функция возвращает NULL, если любой из аргументов при вызове NULL. В этом случае функция фактически не будет вызываться вовсе. Функции, не являющиеся «строгими», должны быть готовы принять значения NULL.

proretset bool

Функция возвращает множество (т. е. множество значений указанного типа данных)

provolatile char

Свойство provolatile говорит, зависит ли результат функции только от её входных аргументов, либо на него влияют внешние факторы. Буквой i обозначаются постоянные функции («immutable»), которые всегда возвращают один результат для одних и тех же аргументов. Буквой s обозначаются стабильные функции («stable»), результаты которых (для одних и тех же аргументов) не меняются в ходе одного сканирования. Буквой v обозначаются изменчивые функции («volatile»), результаты которых могут меняться в любое время. (Так же v следует выбирать для функций с побочными эффектами, чтобы система не оптимизировала их вызовы.)

proparallel char

Свойство proparallel говорит, может ли эта функция безопасно выполняться в параллельном режиме. Символом s в нём обозначаются функции, которые могут выполняться в параллельном режиме без ограничений. Символом r обозначаются функции, которые могут выполняться в параллельном режиме, но только в ведущем процессе группы; в параллельных рабочих процессах вызывать их нельзя. Символом u отмечаются функции небезопасные в параллельном режиме; присутствие такой функции влечёт выбор последовательного плана выполнения запроса.

pronargs int2

Число входных аргументов

pronargdefaults int2

Число аргументов, для которых определены значения по умолчанию

prorettype oid (ссылается на pg_type.oid)

Тип данных возвращаемого значения

proargtypes oidvector (ссылается на pg_type.oid)

Массив типов аргументов функции. В нём учитываются только входные аргументы функции (включая аргументы INOUT и VARIADIC), так что он представляет сигнатуру вызова функции.

proallargtypes oid[] (ссылается на pg_type.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[] (ссылается на pg_type.oid)

Массив типов аргументов/результатов, к которым должны применяться трансформации (заданные в предложении TRANSFORM объявления функции), либо NULL, если таковых нет.

prosrc text

Это значение говорит обработчику функции, как вызывать данную функцию. Это может быть собственно исходный код функции для интерпретируемых языков, объектный символ, имя файла или что-то другое, в зависимости от языка реализации/соглашения о вызовах.

probin text

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

prosqlbody pg_node_tree

Предварительно разобранное тело SQL-функции. Используется для функций на языке SQL, когда тело функции оформлено по стандарту SQL, а не в виде строки. В других случаях — NULL.

proconfig text[]

Локальные присваивания конфигурационных переменных времени выполнения, действующие в рамках функции

proacl aclitem[]

Права доступа; за подробностями обратитесь к Разделу 5.7.

Для скомпилированных функций, как встроенных, так и динамически загружаемых, поле prosrc содержит имя функции на языке C (объектный символ). Для функций на языке SQL: если функция определена в виде строки, поле prosrc содержит исходный код функции; если же функция оформлена по стандарту SQL, поле prosrc не используется (обычно это пустая строка), а поле prosqlbody содержит предварительно разобранное определение функции. Для всех других известных сегодня языков поле prosrc содержит исходный код функции. Поле probin используется только для динамически загружаемых функций на C, для которых оно задаёт имя разделяемой библиотеки, содержащей эти функции.

Пред.	Наверх	След.
51.37. `pg_policy`	Начало	51.39. `pg_profile`

51.38. `pg_proc`
Prev	Up	Chapter 51. System Catalogs	Home	Next

51.38. `pg_proc`

The catalog pg_proc stores information about functions, procedures, aggregate functions, and window functions (collectively also known as routines). See CREATE FUNCTION, CREATE PROCEDURE, and Section 37.3 for more information.

If prokind indicates that the entry is for an aggregate function, there should be a matching row in pg_aggregate.

Table 51.38. pg_proc Columns

Column Type Description
`oid` `oid` Row identifier
`proname` `name` Name of the function
`pronamespace` `oid` (references `pg_namespace`.`oid`) The OID of the namespace that contains this function
`proowner` `oid` (references `pg_authid`.`oid`) Owner of the function
`prolang` `oid` (references `pg_language`.`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` (references `pg_type`.`oid`) Data type of the variadic array parameter's elements, or zero if the function does not have a variadic parameter
`prosupport` `regproc` (references `pg_proc`.`oid`) Planner support function for this function (see Section 37.11), or zero if none
`prokind` `char` `f` for a normal function, `p` for a procedure, `a` for an aggregate function, or `w` for 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.)
`proparallel` `char` `proparallel` tells whether the function can be safely run in parallel mode. It is `s` for functions which are safe to run in parallel mode without restriction. It is `r` for functions which can be run in parallel mode, but their execution is restricted to the parallel group leader; parallel worker processes cannot invoke these functions. It is `u` for functions which are unsafe in parallel mode; the presence of such a function forces a serial execution plan.
`pronargs` `int2` Number of input arguments
`pronargdefaults` `int2` Number of arguments that have defaults
`prorettype` `oid` (references `pg_type`.`oid`) Data type of the return value
`proargtypes` `oidvector` (references `pg_type`.`oid`) An array of 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[]` (references `pg_type`.`oid`) An array of 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 of 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 of 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[]` (references `pg_type`.`oid`) An array of the argument/result data type(s) for which to apply transforms (from the function's `TRANSFORM` clause). Null if none.
`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.
`prosqlbody` `pg_node_tree` Pre-parsed SQL function body. This is used for SQL-language functions when the body is given in SQL-standard notation rather than as a string literal. It's null in other cases.
`proconfig` `text[]` Function's local settings for run-time configuration variables
`proacl` `aclitem[]` Access privileges; see Section 5.7 for details

Column Type

Description

oid oid

Row identifier

proname name

Name of the function

pronamespace oid (references pg_namespace.oid)

The OID of the namespace that contains this function

proowner oid (references pg_authid.oid)

Owner of the function

prolang oid (references pg_language.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 (references pg_type.oid)

Data type of the variadic array parameter's elements, or zero if the function does not have a variadic parameter

prosupport regproc (references pg_proc.oid)

Planner support function for this function (see Section 37.11), or zero if none

prokind char

f for a normal function, p for a procedure, a for an aggregate function, or w for 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.)

proparallel char

proparallel tells whether the function can be safely run in parallel mode. It is s for functions which are safe to run in parallel mode without restriction. It is r for functions which can be run in parallel mode, but their execution is restricted to the parallel group leader; parallel worker processes cannot invoke these functions. It is u for functions which are unsafe in parallel mode; the presence of such a function forces a serial execution plan.

pronargs int2

Number of input arguments

pronargdefaults int2

Number of arguments that have defaults

prorettype oid (references pg_type.oid)

Data type of the return value

proargtypes oidvector (references pg_type.oid)

An array of 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[] (references pg_type.oid)

An array of 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 of 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 of 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[] (references pg_type.oid)

An array of the argument/result data type(s) for which to apply transforms (from the function's TRANSFORM clause). Null if none.

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.

prosqlbody pg_node_tree

Pre-parsed SQL function body. This is used for SQL-language functions when the body is given in SQL-standard notation rather than as a string literal. It's null in other cases.

proconfig text[]

Function's local settings for run-time configuration variables

proacl aclitem[]

Access privileges; see Section 5.7 for details

For compiled functions, both built-in and dynamically loaded, prosrc contains the function's C-language name (link symbol). For SQL-language functions, prosrc contains the function's source text if that is specified as a string literal; but if the function body is specified in SQL-standard style, prosrc is unused (typically it's an empty string) and prosqlbody contains the pre-parsed definition. For all other currently-known language types, prosrc contains the function's source text. probin is null except for dynamically-loaded C functions, for which it gives the name of the shared library file containing the function.

Prev	Up	Next
51.37. `pg_policy`	Home	51.39. `pg_profile`