49.37. pg_proc
The catalogpg_proc stores information about functions (or procedures). SeeCREATE FUNCTION andSection 35.3 for more information.
The table contains data for aggregate functions as well as plain functions. Ifproisagg is true, there should be a matching row inpg_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 ofcpu_operator_cost); ifproretset, this is cost per row returned | |
prorows | float4 | Estimated number of result rows (zero if notproretset) | |
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 (seeSection 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 isi for“immutable” functions, which always deliver the same result for the same inputs. It iss for“stable” functions, whose results (for fixed inputs) do not change within a scan. It isv for“volatile” functions, whose results might change at any time. (Usev 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 (includingINOUT andVARIADIC 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 (includingOUT andINOUT arguments); however, if all the arguments areIN arguments, this field will be null. Note that subscripting is 1-based, whereas for historical reasonsproargtypes is subscripted from 0. |
proargmodes | char[] | An array with the modes of the function arguments, encoded asi forIN arguments,o forOUT arguments,b forINOUT arguments,v forVARIADIC arguments,t forTABLE arguments. If all the arguments areIN arguments, this field will be null. Note that subscripts correspond to positions ofproallargtypes notproargtypes. | |
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 ofproallargtypes notproargtypes. | |
proargdefaults | pg_node_tree | Expression trees (innodeToString() representation) for default values. This is a list withpronargdefaults elements, corresponding to the lastNinput arguments (i.e., the lastNproargtypes 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; seeGRANT andREVOKE 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.