2024年9月26日: PostgreSQL 17 发布!
支持的版本:当前 (17) / 16 / 15 / 14 / 13 / 12
开发版本:devel
不受支持的版本:11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4 / 7.3 / 7.2 / 7.1

51.39. pg_proc #

目录pg_proc存储有关函数、过程、聚合函数和窗口函数(统称为例程)的信息。有关详细信息,请参见CREATE FUNCTIONCREATE PROCEDURE第36.3节

如果prokind指示该条目是聚合函数,则pg_aggregate中应存在一个匹配的行。

表 51.39. 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

可变参数数组参数的元素的数据类型,如果函数没有可变参数,则为零

prosupport regproc (引用pg_proc.oid

此函数的规划器支持函数(请参见第36.11节),如果不存在,则为零

prokind char

对于普通函数为f,对于过程为p,对于聚合函数为a,对于窗口函数为w

prosecdef bool

函数是安全定义者(即setuid函数)

proleakproof bool

该函数没有副作用。除了通过返回值之外,不会传递有关参数的任何信息。任何可能根据其参数的值抛出错误的函数都不是防泄漏的。

proisstrict bool

如果任何调用参数为 null,则函数返回 null。在这种情况下,实际上根本不会调用该函数。不是strict的函数必须准备好处理 null 输入。

proretset bool

函数返回一个集合(即指定数据类型的多个值)

provolatile char

provolatile指示函数的结果是否仅取决于其输入参数,或受外部因素影响。对于始终对相同输入提供相同结果的immutable函数,它是i。对于在扫描内结果(对于固定输入)不会改变的stable函数,它是s。对于结果可能随时变化的volatile函数,它是v。(对于具有副作用的函数也使用v,以便无法优化对它们的调用。)

proparallel char

proparallel指示函数是否可以安全地在并行模式下运行。对于可以在并行模式下运行而无需限制的函数,它是s。对于可以在并行模式下运行但其执行仅限于并行组领导者的函数,它是r;并行工作进程无法调用这些函数。对于在并行模式下不安全的函数,它是u;此类函数的存在会强制执行串行执行计划。

pronargs int2

输入参数的数量

pronargdefaults int2

具有默认值的参数数量

prorettype oid (引用pg_type.oid

返回值的数据类型

proargtypes oidvector (引用pg_type.oid

函数参数的数据类型的数组。这仅包括输入参数(包括INOUTVARIADIC参数),因此表示函数的调用签名。

proallargtypes oid[] (引用pg_type.oid

函数参数的数据类型的数组。这包括所有参数(包括OUTINOUT参数);但是,如果所有参数都是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输入参数(即最后的Nproargtypes位置)。如果没有任何参数具有默认值,则此字段将为 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.8节


对于编译后的函数,包括内置函数和动态加载函数,prosrc 包含函数的 C 语言名称(链接符号)。对于 SQL 语言函数,如果函数源代码以字符串字面量指定,则 prosrc 包含函数的源代码文本;但如果函数体以 SQL 标准样式指定,则 prosrc 未使用(通常为空字符串),并且 prosqlbody 包含预解析的定义。对于所有其他当前已知的语言类型,prosrc 包含函数的源代码文本。 probin 为空,除非对于动态加载的 C 函数,在这种情况下,它给出包含该函数的共享库文件的名称。

提交更正

如果您在文档中发现任何不正确的内容、与您对特定功能的体验不符的内容或需要进一步澄清的内容,请使用此表单报告文档问题。