select open change scope Open full search

PG.CENTER connects PostgreSQL documentation, reference, and ecosystem knowledge. Maintained by Pigsty.

SYSTEM CATALOGS / SYSTEM CATALOGS

The catalog pg_proc stores information about functions, procedures, aggregate functions, and window functions (collectively also known as routines).

Kind
System catalogs
Columns in this snapshot
30
Definition source
English manual

Columns 30

ColumnTypeDescription / reference
oidoidRow identifier
pronamenameName of the function
pronamespaceoidThe OID of the namespace that contains this function
pg_namespace.oid
proowneroidOwner of the function
pg_authid.oid
prolangoidImplementation language or call interface of this function
pg_language.oid
procostfloat4Estimated execution cost (in units of cpu_operator_cost); if proretset, this is cost per row returned
prorowsfloat4Estimated number of result rows (zero if not proretset)
provariadicoidData type of the variadic array parameter's elements, or zero if the function does not have a variadic parameter
pg_type.oid
prosupportregprocPlanner support function for this function (see Section 36.11), or zero if none
prokindcharf for a normal function, p for a procedure, a for an aggregate function, or w for a window function
prosecdefboolFunction is a security definer (i.e., a “setuid” function)
proleakproofboolThe 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 leakproof.
proisstrictboolFunction 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.
proretsetboolFunction returns a set (i.e., multiple values of the specified data type)
provolatilecharprovolatile 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.)
proparallelcharproparallel 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.
pronargsint2Number of input arguments
pronargdefaultsint2Number of arguments that have defaults
prorettypeoidData type of the return value
pg_type.oid
proargtypesoidvectorAn 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.
pg_type.oid
proallargtypesoid[]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.
pg_type.oid
proargmodeschar[]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.
proargnamestext[]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.
proargdefaultspg_node_treeExpression 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.
protrftypesoid[]An array of the argument/result data type(s) for which to apply transforms (from the function's TRANSFORM clause). Null if none.
pg_type.oid
prosrctextThis 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.
probintextAdditional information about how to invoke the function. Again, the interpretation is language-specific.
prosqlbodypg_node_treePre-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.
proconfigtext[]Function's local settings for run-time configuration variables
proaclaclitem[]Access privileges; see Section 5.8 for details
Column history across versions
Column9.09.19.29.39.49.59.61011121314151617181920
oid···
proname
pronamespace
proowner
prolang
procost
prorows
provariadic
protransform···········
proisagg··········
proiswindow··········
prosecdef
proleakproof··
proisstrict
proretset
provolatile
proparallel······
pronargs
pronargdefaults
prorettype
proargtypes
proallargtypes
proargmodes
proargnames
proargdefaults
protrftypes·····
prosrc
probin
proconfig
proacl
prokind········
prosupport·········
prosqlbody···········
Version history 13
  1. PG 18 → 19changed
  2. PG 17 → 18changed
  3. PG 16 → 17changed
  4. PG 13 → 14changed
  5. PG 12 → 13changed
  6. PG 11 → 12changed
  7. PG 10 → 11changed
  8. PG 9.6 → 10changed
  9. PG 9.5 → 9.6changed
  10. PG 9.4 → 9.5changed
  11. PG 9.2 → 9.3changed
  12. PG 9.1 → 9.2changed
  13. PG 9.0 → 9.1changed

Definition snapshot: english-manuals:206a7957138fb574daee2c6c9c2… · English manual source