Updated on 2024-06-03 GMT+08:00

PG_PROC

PG_PROC records information about functions or procedures.

Table 1 PG_PROC columns

Name

Type

Description

oid

oid

Row identifier (hidden attribute, which must be specified).

proname

name

Function name.

pronamespace

oid

OID of the namespace that contains the function.

proowner

oid

Owner of the function.

prolang

oid

Implementation language or call interface of the function.

procost

real

Estimated execution cost.

prorows

real

Estimated number of rows that are influenced.

provariadic

oid

Data type of parameter element.

protransform

regproc

Simplified call method for the function.

proisagg

Boolean

Specifies whether the function is an aggregate function.

  • t (true): yes
  • f (false): no

proiswindow

Boolean

Specifies whether the function is a window function.

  • t (true): yes
  • f (false): no

prosecdef

Boolean

Specifies whether the function is a security definer (or a setuid function).

  • t (true): yes
  • f (false): no

proleakproof

Boolean

Specifies whether the function has side effects. If no leakproof treatment is provided for parameters, the function throws errors.

  • t (true): There is no side effect.
  • f (false): There are side effects.

proisstrict

Boolean

  • t (true): When this function is used, the function does not invoke the function and returns null if the input parameter is null.
  • f (false): When this function is used, it is invoked even if the input parameter is null. Therefore, this function must process null input.

proretset

Boolean

Specifies whether the return value of the function is a set (that is, multiple values of the specified data type).

  • true: The return value of the function is a set.
  • false: The return value of the function is not a set.

provolatile

"char"

Specifies whether the function's result depends only on its input parameters, or is affected by outside factors.
  • i: immutable functions, which always deliver the same result for the same inputs.
  • s: stable functions, whose results (for fixed inputs) do not change within a scan.
  • v: volatile functions, whose results may change at any time. Use v also for functions with side-effects, so that the engine cannot get optimized if volatile functions are called.

pronargs

smallint

Number of parameters.

pronargdefaults

smallint

Number of parameters that have default values.

prorettype

oid

Data type of return values.

proargtypes

oidvector

Array that stores the data types of function parameters. This array includes only input parameters (including INOUT parameters), and indicates the call signature (interface) of the function.

proallargtypes

oid[]

Array that contains the data types of function parameters. This array includes all parameter types (including OUT and INOUT parameters); however, if all the parameters are IN parameters, this column is null. Note that array subscripting is 1-based, whereas for historical reasons, proargtypes is subscripted from 0.

proargmodes

"char"[]

Array with the modes of the function parameters, encoded as follows:

  • i indicates the IN parameter.
  • o indicates the OUT parameter.
  • b indicates the INOUT parameter.
  • v indicates the VARIADIC parameter.

If all the parameters are IN parameters, this column is null. Note that subscripts correspond to positions of proallargtypes, not proargtypes.

proargnames

text[]

Array that stores the names of the function parameters. Parameters without a name are set to empty strings in the array. If none of the parameters have a name, this column is null. Note that subscripts correspond to positions of proallargtypes, not proargtypes.

proargdefaults

pg_node_tree

Expression tree of the default value. This is the list of pronargdefaults elements.

prosrc

text

A definition that describes a function or stored procedure. In an interpreting language, it is the function source code, a link symbol, a file name, or any body content specified when a function or stored procedure is created, depending on how a language or call is used.

probin

text

Additional information about how to call the function. Again, the interpretation is language-specific.

proconfig

text[]

Function's local settings for run-time configuration variables.

proacl

aclitem[]

Access permission. For details, see GRANT and REVOKE.

prodefaultargpos

int2vector

Position of the input parameter of a function with a default value.

fencedmode

Boolean

Execution mode of a function, indicating whether the function is executed in fence or not fence mode.

  • true: fence mode. In this mode, the function is executed in the fork process.
  • false: not fence mode.

For built-in functions in the system, fencedmode is set to false, indicating the not fence mode.

proshippable

Boolean

Specifies whether the function can be pushed down to DNs for execution. The default value is false.
  • Functions of the IMMUTABLE type can always be pushed down to DNs.
  • Functions of the STABLE or VOLATILE type can be pushed down to DNs only if their attribute is SHIPPABLE.

propackage

Boolean

Specifies whether the function supports overloading. The default value is false.

  • t (true): supported.
  • f (false): not supported.

prokind

"char"

Specifies whether the object is a function or a stored procedure.

  • 'f': The object is a function.
  • 'p': The object is a stored procedure.

proargsrc

text

Describes the parameter input strings of functions or stored procedures that are compatible with ORA syntax, including parameter comments. The default value is NULL.

proargtypesext

oidvector_extend

Data type array used to store function parameters when there are a large number of function parameters. This array includes only input parameters (including INOUT parameters), and indicates the call signature (interface) of the function.

prodefaultargposext

int2vector_extend

Position of the input parameter with a default value when the function has a large number of parameters.

allargtypes

oidvector

Array for storing the data types of stored procedure parameters, including all parameters (input parameters, output parameters, and INOUT parameters) of the stored procedure.

allargtypesext

oidvector_extend

Array for storing the data types of stored procedure parameters when the number of function parameters is greater than 666. The array contains all parameters (including input parameters, output parameters, and INOUT parameters).

When a function is created, data is inserted into the PG_PROC catalog to update the index. When there are a large number of input and output parameters, the index length may exceed one third of the page length. As a result, the error "Index row size xxx exceeds maximum xxx for index 'pg_proc_proname_all_args_nsp_index'" may be reported as expected. You can reduce the number of parameters to avoid this error.