9.26. 系统信息函数和运算符#

9.26.1. 会话信息函数

9.26.2. 访问权限查询函数

9.26.3. 模式可见性查询函数

9.26.4. 系统目录信息函数

9.26.5. 对象信息和寻址函数

9.26.6. 注释信息函数

9.26.7. 数据有效性检查函数

9.26.8. 事务 ID 和快照信息函数

9.26.9. 已提交事务信息函数

9.26.10. 控制数据函数

本节所述函数用于获取有关PostgreSQL安装的各种信息。

9.26.1. 会话信息函数#

表 9.67显示了几个提取会话和系统信息的函数。

除了本节中列出的函数外，还有许多与统计系统相关的函数也提供系统信息。有关详细信息，请参见第 28.2.25 节。

表 9.67. 会话信息函数

函数 说明
current_catalog → name current_database () → name 返回当前数据库的名称。（在 SQL 标准中，数据库称为 “目录”，因此 current_catalog 是该标准的拼写方式。）
current_query () → text 返回当前执行查询的文本，由客户端提交（可能包含多条语句）。
current_role → name 这等同于 current_user。
current_schema → name current_schema () → name 返回搜索路径中第一个模式的名称（如果搜索路径为空，则返回 null 值）。这是将用于创建任何未指定目标模式的表或其他命名对象的模式。
current_schemas ( include_implicit boolean ) → name[] 返回当前有效搜索路径中所有模式名称的数组，按其优先级顺序排列。（当前 search_path 设置中与现有可搜索模式不对应的项将被省略。）如果布尔参数为 true，则隐式搜索的系统模式（如 pg_catalog）将包含在结果中。
current_user → name 返回当前执行上下文的用户名。
inet_client_addr () → inet 返回当前客户端的 IP 地址，如果当前连接是通过 Unix 域套接字进行的，则返回 NULL。
inet_client_port () → integer 返回当前客户端的 IP 端口号，如果当前连接是通过 Unix 域套接字进行的，则返回 NULL。
inet_server_addr () → inet 返回服务器接受当前连接的 IP 地址，如果当前连接是通过 Unix 域套接字进行的，则返回 NULL。
inet_server_port () → integer 返回服务器接受当前连接的 IP 端口号，如果当前连接是通过 Unix 域套接字进行的，则返回 NULL。
pg_backend_pid () → integer 返回附加到当前会话的服务器进程的进程 ID。
pg_blocking_pids ( integer ) → integer[] 返回一个进程 ID 数组，这些进程 ID 属于阻止具有指定进程 ID 的服务器进程获取锁的会话，或者如果不存在这样的服务器进程或它未被阻止，则返回一个空数组。 如果服务器进程持有与被阻止进程的锁请求冲突的锁（硬阻止），或者正在等待一个与被阻止进程的锁请求冲突的锁并且在等待队列中排在它前面（软阻止），则一个服务器进程会阻止另一个服务器进程。在使用并行查询时，即使实际锁是由子工作进程持有或等待，结果始终会列出客户端可见的进程 ID（即，pg_backend_pid 结果）。因此，结果中可能存在重复的 PID。还要注意，当一个准备好的事务持有冲突锁时，它将由一个零进程 ID 表示。 频繁调用此函数可能会对数据库性能产生一定影响，因为它需要在短时间内独占访问锁管理器的共享状态。
pg_conf_load_time () → 带时区的 timestamp 返回服务器配置文件上次加载的时间。如果当前会话当时处于活动状态，这将是会话本身重新读取配置文件的时间（因此不同会话中的读取时间会略有不同）。否则，这是后主进程重新读取配置文件的时间。
pg_current_logfile ( [ text ] ) → text 返回日志收集器当前正在使用的日志文件的路径名。路径包括 log_directory 目录和各个日志文件名。如果日志收集器已禁用，则结果为 NULL。当存在多个日志文件，每个文件采用不同的格式时，不带参数的 pg_current_logfile 返回在以下有序列表中找到的第一个格式的文件路径：stderr、csvlog、jsonlog。如果没有任何日志文件具有这些格式，则返回 NULL。要请求有关特定日志文件格式的信息，请将 csvlog、jsonlog 或 stderr 作为可选参数的值提供。如果在 log_destination 中未配置请求的日志格式，则结果为 NULL。结果反映了 current_logfiles 文件的内容。
pg_my_temp_schema () → oid 返回当前会话临时架构的 OID，如果没有（因为它没有创建任何临时表），则返回零。
pg_is_other_temp_schema ( oid ) → boolean 如果给定的 OID 是另一个会话的临时架构的 OID，则返回 true。（例如，这可用于从目录显示中排除其他会话的临时表。）
pg_jit_available () → boolean 如果 编译器扩展可用（参见 第 32 章），并且 jit 配置参数设置为 on，则返回 true。
pg_listening_channels () → setof text 返回当前会话正在监听的异步通知通道的名称集合。
pg_notification_queue_usage () → double precision 返回异步通知队列的最大大小中当前被等待处理的通知所占的比例 (0-1)。有关详细信息，请参见 LISTEN 和 NOTIFY。
pg_postmaster_start_time () → timestamp with time zone 返回服务器启动的时间。
pg_safe_snapshot_blocking_pids ( integer ) → integer[] 返回阻止具有指定进程 ID 的服务器进程获取安全快照的会话的进程 ID 数组，如果没有这样的服务器进程或它未被阻止，则返回一个空数组。 运行 SERIALIZABLE 事务的会话会阻止 SERIALIZABLE READ ONLY DEFERRABLE 事务获取快照，直到后者确定可以安全地避免获取任何谓词锁。有关可序列化和可延迟事务的详细信息，请参见 第 13.2.3 节。 频繁调用此函数可能会对数据库性能产生一定影响，因为它需要在短时间内访问谓词锁管理器的共享状态。
pg_trigger_depth () → integer 返回 PostgreSQL 触发器的当前嵌套级别（如果未直接或间接从触发器内部调用，则为 0）。
session_user → name 返回会话用户的名称。
system_user → text 返回用户在被分配数据库角色之前在认证周期中提供的认证方法和身份（如果有）。它表示为 auth_method:identity 或 NULL（如果用户尚未经过认证，例如如果使用了 信任认证）。
user → name 这等同于 current_user。
version () → text 返回描述 PostgreSQL 服务器版本的字符串。您还可以从 server_version 获取此信息，或者对于机器可读版本，请使用 server_version_num。软件开发人员应该使用 server_version_num（自 8.2 起可用）或 PQserverVersion 而不是解析文本版本。

注意

current_catalog、current_role、current_schema、current_user、session_user和user在SQL中具有特殊的语法状态：它们必须在没有尾随括号的情况下调用。在 PostgreSQL 中，括号可以与current_schema一起使用（可选），但不能与其他函数一起使用。

通常，session_user是发起当前数据库连接的用户；但超级用户可以使用SET SESSION AUTHORIZATION更改此设置。current_user是适用于权限检查的用户标识符。通常它等于会话用户，但可以使用SET ROLE进行更改。它还将在执行具有属性SECURITY DEFINER的函数期间发生更改。用 Unix 术语来说，会话用户是“实际用户”，而当前用户是“有效用户”。current_role和user是current_user的同义词。（SQL 标准在current_role和current_user之间做出了区分，但PostgreSQL没有，因为它将用户和角色统一为一种类型的实体。）

9.26.2. 访问权限查询函数#

表 9.68列出了允许以编程方式查询对象访问权限的函数。（有关权限的详细信息，请参见第 5.7 节。）在这些函数中，可以按名称或 OID (pg_authid.oid) 指定要查询其权限的用户，或者如果名称指定为public，则检查 PUBLIC 伪角色的权限。此外，*user*参数可以完全省略，在这种情况下，假定为current_user。要查询的对象也可以按名称或 OID 指定。按名称指定时，如果相关，可以包含架构名称。感兴趣的访问权限由文本字符串指定，该字符串必须评估为对象类型的适当权限关键字之一（例如，SELECT）。还可以将WITH GRANT OPTION添加到权限类型，以测试是否持有具有授予选项的权限。此外，可以列出多个权限类型，用逗号分隔，在这种情况下，如果持有任何列出的权限，结果将为真。（权限字符串的大小写无关紧要，并且允许在权限名称之间留有额外的空格，但不能在权限名称内留有空格。）一些示例

SELECT has_table_privilege('myschema.mytable', 'select');
SELECT has_table_privilege('joe', 'mytable', 'INSERT, SELECT WITH GRANT OPTION');

表 9.68. 访问权限查询函数

函数 说明
has_any_column_privilege ( [ user name 或 oid, ] table text 或 oid, privilege text ) → boolean 用户是否具有表的任何列的权限？如果为整个表持有权限，或者至少为一列授予了列级权限，则此操作将成功。允许的权限类型为 SELECT、INSERT、UPDATE 和 REFERENCES。
has_column_privilege ( [ user name 或 oid, ] table text 或 oid, column text 或 smallint, privilege text ) → boolean 用户是否对指定表列具有权限？如果对整个表持有权限，或者对该列授予了列级权限，则此操作会成功。可以通过名称或属性编号（pg_attribute.attnum）指定列。允许的权限类型为 SELECT、INSERT、UPDATE 和 REFERENCES。
has_database_privilege ( [ user name 或 oid, ] database text 或 oid, privilege text ) → boolean 用户是否对数据库具有权限？允许的权限类型为 CREATE、CONNECT、TEMPORARY 和 TEMP（相当于 TEMPORARY）。
has_foreign_data_wrapper_privilege ( [ user name 或 oid, ] fdw text 或 oid, privilege text ) → boolean 用户是否对外部数据包装器具有权限？唯一允许的权限类型为 USAGE。
has_function_privilege ( [ user name 或 oid, ] function text 或 oid, privilege text ) → boolean 用户是否对函数具有权限？唯一允许的权限类型为 EXECUTE。 通过名称而不是 OID 指定函数时，允许的输入与 regprocedure 数据类型相同（请参阅 第 8.19 节）。示例为 SELECT has_function_privilege('joeuser', 'myfunc(int, text)', 'execute');
has_language_privilege ( [ user name 或 oid, ] language text 或 oid, privilege text ) → boolean 用户是否具有语言权限？唯一允许的权限类型是 USAGE。
has_parameter_privilege ( [ user name 或 oid, ] parameter text, privilege text ) → boolean 用户是否具有配置参数权限？参数名称不区分大小写。允许的权限类型是 SET 和 ALTER SYSTEM。
has_schema_privilege ( [ user name 或 oid, ] schema text 或 oid, privilege text ) → boolean 用户是否具有架构权限？允许的权限类型是 CREATE 和 USAGE。
has_sequence_privilege ( [ user name 或 oid, ] sequence text 或 oid, privilege text ) → boolean 用户是否具有序列权限？允许的权限类型是 USAGE、SELECT 和 UPDATE。
has_server_privilege ( [ user name 或 oid, ] server text 或 oid, privilege text ) → boolean 用户是否具有外部服务器权限？唯一允许的权限类型是 USAGE。
has_table_privilege ( [ user name 或 oid, ] table text 或 oid, privilege text ) → boolean 用户是否具有表权限？允许的权限类型是 SELECT、INSERT、UPDATE、DELETE、TRUNCATE、REFERENCES 和 TRIGGER。
has_tablespace_privilege ( [ user name 或 oid, ] tablespace text 或 oid, privilege text ) → boolean 用户是否具有表空间权限？唯一允许的权限类型是 CREATE。
has_type_privilege ( [ user name 或 oid, ] type text 或 oid, privilege text ) → boolean 用户是否具有数据类型权限？唯一允许的权限类型是 USAGE。当通过名称而不是 OID 指定类型时，允许的输入与 regtype 数据类型相同（请参阅 第 8.19 节）。
pg_has_role ( [ user name 或 oid, ] role text 或 oid, privilege text ) → boolean 用户是否具有角色权限？允许的权限类型是 MEMBER、USAGE 和 SET。 MEMBER 表示直接或间接属于该角色，而不考虑可能授予哪些特定权限。 USAGE 表示角色的权限是否可以立即使用，而无需执行 SET ROLE，而 SET 表示是否可以使用 SET ROLE 命令更改为该角色。此函数不允许将 user 设置为 public 的特殊情况，因为 PUBLIC 伪角色永远不可能成为真实角色的成员。
row_security_active ( table text 或 oid ) → boolean 在当前用户和当前环境的上下文中，指定表是否启用了行级安全性？

表 9.69显示了aclitem类型的可用运算符，该类型是访问权限的目录表示形式。有关如何读取访问权限值的信息，请参见第 5.7 节。

表 9.69.aclitem运算符

运算符 说明 示例
aclitem = aclitem → boolean 是否 aclitem 相等？（请注意，类型 aclitem 缺少通常的比较运算符集；它只有相等性。反过来，aclitem 数组只能比较相等性。） 'calvin=r*w/hobbes'::aclitem = 'calvin=r*w*/hobbes'::aclitem → f
aclitem[] @> aclitem → boolean 数组是否包含指定的权限？（如果有一个数组项与 aclitem 的授权人和授权者匹配，并且至少具有指定的一组权限，则为真。） '{calvin=r*w/hobbes,hobbes=r*w*/postgres}'::aclitem[] @> 'calvin=r*/hobbes'::aclitem → t
aclitem[] ~ aclitem → boolean 这是 @> 的已弃用别名。 '{calvin=r*w/hobbes,hobbes=r*w*/postgres}'::aclitem[] ~ 'calvin=r*/hobbes'::aclitem → t

表 9.70显示了一些用于管理aclitem类型的其他函数。

表 9.70.aclitem函数

函数 说明
acldefault ( type "char", ownerId oid ) → aclitem[] 构造一个aclitem数组，其中包含属于 OID 为ownerId的角色的类型type对象的默认访问权限。这表示当对象的 ACL 条目为 null 时将假定的访问权限。（默认访问权限在第 5.7 节中进行描述。）type参数必须是 'c'（表示COLUMN）、'r'（表示TABLE和类似表的对象）、's'（表示SEQUENCE）、'd'（表示DATABASE）、'f'（表示FUNCTION或PROCEDURE）、'l'（表示LANGUAGE）、'L'（表示LARGE OBJECT）、'n'（表示SCHEMA）、'p'（表示PARAMETER）、't'（表示TABLESPACE）、'F'（表示FOREIGN DATA WRAPPER）、'S'（表示FOREIGN SERVER）或 'T'（表示TYPE或DOMAIN）。
aclexplode ( aclitem[] ) → setof record ( grantor oid, grantee oid, privilege_type text, is_grantable boolean ) 以一组行的形式返回aclitem数组。如果被授予者是伪角色 PUBLIC，则在grantee列中将其表示为零。每个已授予的权限都表示为SELECT、INSERT等（有关完整列表，请参见表 5.1）。请注意，每个权限都作为单独的行进行分解，因此privilege_type列中只出现一个关键字。
makeaclitem ( grantee oid, grantor oid, privileges text, is_grantable boolean ) → aclitem 使用给定的属性构造一个aclitem。privileges是一个逗号分隔的权限名称列表，例如SELECT、INSERT等，所有这些都设置在结果中。（权限字符串的大小写无关紧要，并且在权限名称之间（但不在权限名称内）允许有额外的空格。）

9.26.3. 模式可见性查询函数#

表 9.71显示了确定某个对象是否在当前架构搜索路径中可见的函数。例如，如果表所在架构在搜索路径中且在搜索路径中没有出现同名表，则该表可见。这等同于该表可以通过名称引用，而无需显式架构限定。因此，要列出所有可见表的名称

SELECT relname FROM pg_class WHERE pg_table_is_visible(oid);

对于函数和运算符，如果在路径中没有同名且具有相同参数数据类型的对象，则搜索路径中的对象可见。对于运算符类和族，名称和关联的索引访问方法都被考虑在内。

表 9.71。架构可见性查询函数

函数 说明
pg_collation_is_visible ( collation oid ) → boolean 排序规则在搜索路径中可见吗？
pg_conversion_is_visible ( conversion oid ) → boolean 转换在搜索路径中可见吗？
pg_function_is_visible ( function oid ) → boolean 函数在搜索路径中可见吗？（这也适用于过程和聚合。）
pg_opclass_is_visible ( opclass oid ) → boolean 运算符类在搜索路径中可见吗？
pg_operator_is_visible ( operator oid ) → boolean 运算符在搜索路径中可见吗？
pg_opfamily_is_visible ( opclass oid ) → boolean 运算符族在搜索路径中可见吗？
pg_statistics_obj_is_visible ( stat oid ) → boolean 统计对象在搜索路径中可见吗？
pg_table_is_visible ( table oid ) → boolean 表在搜索路径中可见吗？（适用于所有类型的关系，包括视图、物化视图、索引、序列和外部表。）
pg_ts_config_is_visible ( config oid ) → boolean 文本搜索配置是否在搜索路径中可见？
pg_ts_dict_is_visible ( dict oid ) → boolean 文本搜索词典是否在搜索路径中可见？
pg_ts_parser_is_visible ( parser oid ) → boolean 文本搜索解析器是否在搜索路径中可见？
pg_ts_template_is_visible ( template oid ) → boolean 文本搜索模板是否在搜索路径中可见？
pg_type_is_visible ( type oid ) → boolean 类型（或域）是否在搜索路径中可见？

所有这些函数都需要对象 OID 来标识要检查的对象。如果您想按名称测试对象，则使用 OID 别名类型（regclass、regtype、regprocedure、regoperator、regconfig或regdictionary）会很方便，例如

SELECT pg_type_is_visible('myschema.widget'::regtype);

请注意，以这种方式测试非模式限定类型名称没有多大意义 — 如果名称可以识别，则它必须是可见的。

9.26.4. 系统目录信息函数#

表 9.72列出了从系统目录中提取信息的函数。

表 9.72. 系统目录信息函数

函数 说明
format_type ( type oid, typemod integer ) → text 返回由其类型 OID 和可能的类型修饰符标识的数据类型的 SQL 名称。如果不知道特定修饰符，请为类型修饰符传递 NULL。
pg_char_to_encoding ( encoding name ) → integer 将提供的编码名称转换为表示某些系统目录表中使用的内部标识符的整数。如果提供了未知的编码名称，则返回 -1。
pg_encoding_to_char ( encoding integer ) → name 将用作某些系统目录表中编码的内部标识符的整数转换为人类可读的字符串。如果提供了无效的编码编号，则返回一个空字符串。
pg_get_catalog_foreign_keys () → setof record ( fktable regclass, fkcols text[], pktable regclass, pkcols text[], is_array boolean, is_opt boolean ) 返回一组记录，描述 PostgreSQL 系统目录中存在的外部键关系。fktable 列包含引用目录的名称，fkcols 列包含引用列的名称。类似地，pktable 列包含被引用目录的名称，pkcols 列包含被引用列的名称。如果 is_array 为真，则最后一个引用列是一个数组，其每个元素都应与被引用目录中的某个条目匹配。如果 is_opt 为真，则允许引用列包含零而不是有效的引用。
pg_get_constraintdef ( constraint oid [, pretty boolean ] ) → text 重建约束的创建命令。（这是一个反编译的重建，而不是命令的原始文本。）
pg_get_expr ( expr pg_node_tree, relation oid [, pretty boolean ] ) → text 反编译存储在系统目录中的表达式的内部形式，例如列的默认值。如果表达式可能包含 Vars，请将它们引用的关系的 OID 指定为第二个参数；如果预计没有 Vars，则传递零就足够了。
pg_get_functiondef ( func oid ) → text 重建函数或过程的创建命令。（这是一个反编译的重建，而不是命令的原始文本。）结果是一个完整的 CREATE OR REPLACE FUNCTION 或 CREATE OR REPLACE PROCEDURE 语句。
pg_get_function_arguments ( func oid ) → text 重建函数或过程的参数列表，其形式需要出现在 CREATE FUNCTION 中（包括默认值）。
pg_get_function_identity_arguments ( func oid ) → text 重建识别函数或过程所需的参数列表，其形式需要出现在 ALTER FUNCTION 等命令中。此形式省略了默认值。
pg_get_function_result ( func oid ) → text 重建函数的 RETURNS 子句，其形式需要出现在 CREATE FUNCTION 中。对于过程返回 NULL。
pg_get_indexdef ( index oid [, column integer, pretty boolean ] ) → text 重建索引的创建命令。（这是一个反编译的重建，而不是命令的原始文本。）如果提供了 column 且不为零，则只重建该列的定义。
pg_get_keywords () → setof record ( word text, catcode "char", barelabel boolean, catdesc text, baredesc text ) 返回一组记录，描述服务器识别的 SQL 关键字。word 列包含关键字。catcode 列包含类别代码：U 表示未保留关键字，C 表示可以作为列名的关键字，T 表示可以作为类型或函数名的关键字，R 表示完全保留的关键字。barelabel 列包含 true（如果关键字可用作 SELECT 列表中的“bare”列标签），或 false（如果关键字只能在 AS 之后使用）。catdesc 列包含描述关键字类别的可能本地化字符串。baredesc 列包含描述关键字列标签状态的可能本地化字符串。
pg_get_partkeydef ( table oid ) → text 以 CREATE TABLE 的 PARTITION BY 子句中显示的格式，重建分区表的 partition key 定义。（这是一个反编译的重建，而不是命令的原始文本。）
pg_get_ruledef ( rule oid [, pretty boolean ] ) → text 重建用于创建规则的命令。（这是一个反编译的重建，而不是命令的原始文本。）
pg_get_serial_sequence ( table text, column text ) → text 返回与列关联的序列的名称，如果没有序列与该列关联，则返回 NULL。如果该列是标识列，则关联的序列是为该列内部创建的序列。对于使用其中一种序列类型（serial、smallserial、bigserial）创建的列，它是为该序列列定义创建的序列。在后一种情况下，可以使用 ALTER SEQUENCE OWNED BY 修改或删除关联。（此函数可能应该称为 pg_get_owned_sequence；其当前名称反映了它历史上已用于序列类型列的事实。）第一个参数是具有可选架构的表名，第二个参数是列名。由于第一个参数可能同时包含架构和表名，因此它按照通常的 SQL 规则进行解析，这意味着它默认情况下是小写的。第二个参数仅仅是一个列名，被逐字处理，因此保留了其大小写。结果经过适当格式化，以便传递给序列函数（请参阅 第 9.17 节）。 典型用法是在读取标识或序列列的序列的当前值，例如 SELECT currval(pg_get_serial_sequence('sometable', 'id'));
pg_get_statisticsobjdef ( statobj oid ) → text 重建扩展统计对象の作成命令。（这是一个反编译重建，而不是命令的原始文本。）
pg_get_triggerdef ( trigger oid [, pretty boolean ] ) → text 重建触发器的创建命令。（这是一个反编译重建，而不是命令的原始文本。）
pg_get_userbyid ( role oid ) → name 给定 OID，返回角色的名称。
pg_get_viewdef ( view oid [, pretty boolean ] ) → text 重建视图或物化视图的底层 SELECT 命令。（这是一个反编译的重建，不是命令的原始文本。）
pg_get_viewdef ( view oid, wrap_column integer ) → text 重建视图或物化视图的底层 SELECT 命令。（这是一个反编译的重建，不是命令的原始文本。）在此函数形式中，始终启用漂亮打印，并且会对长行进行换行，以尝试使其长度小于指定的列数。
pg_get_viewdef ( view text [, pretty boolean ] ) → text 根据视图的文本名称而不是其 OID 重建视图或物化视图的底层 SELECT 命令。（此方法已弃用；请改用 OID 变体。）
pg_index_column_has_property ( index regclass, column integer, property text ) → boolean 测试索引列是否具有命名的属性。常见的索引列属性在 表 9.73 中列出。（请注意，扩展访问方法可以为其索引定义其他属性名称。）如果属性名称未知或不适用于特定对象，或者如果 OID 或列号未标识有效的对象，则返回 NULL。
pg_index_has_property ( index regclass, property text ) → boolean 测试索引是否具有命名的属性。常见的索引属性在 表 9.74 中列出。（请注意，扩展访问方法可以为其索引定义其他属性名称。）如果属性名称未知或不适用于特定对象，或者如果 OID 未标识有效的对象，则返回 NULL。
pg_indexam_has_property ( am oid, property text ) → boolean 测试索引访问方法是否具有命名属性。在 表 9.75 中列出了访问方法属性。如果属性名称未知或不适用于特定对象，或者 OID 未标识有效对象，则返回 NULL。
pg_options_to_table ( options_array text[] ) → setof record ( option_name text, option_value text ) 返回 pg_class.reloptions 或 pg_attribute.attoptions 中的值表示的一组存储选项。
pg_settings_get_flags ( guc text ) → text[] 返回与给定 GUC 关联的标志数组，如果不存在，则返回 NULL。如果 GUC 存在但没有要显示的标志，则结果为空数组。仅 表 9.76 中列出的最有用标志公开。
pg_tablespace_databases ( tablespace oid ) → setof oid 返回存储在指定表空间中的对象的数据库的 OID 集合。如果此函数返回任何行，则表空间不为空，并且不能删除。要识别填充表空间的特定对象，您需要连接到 pg_tablespace_databases 标识的数据库并查询其 pg_class 目录。
pg_tablespace_location ( tablespace oid ) → text 返回此表空间所在的的文件系统路径。
pg_typeof ( "any" ) → regtype 返回传递给它的值的的数据类型的 OID。这对于故障排除或动态构建 SQL 查询很有帮助。该函数声明为返回 regtype，这是一个 OID 别名类型（参见 第 8.19 节）；这意味着它与 OID 相同用于比较目的，但显示为类型名称。 例如 SELECT pg_typeof(33); pg_typeof ----------- integer SELECT typlen FROM pg_type WHERE oid = pg_typeof(33); typlen 4
COLLATION FOR ( "any" ) → text 返回传递给它的值的校对名称。必要时，该值将被引用并限定模式。如果没有为参数表达式导出校对，则返回 NULL。如果参数不是可校对的数据类型，则会引发错误。 例如 SELECT collation for (description) FROM pg_description LIMIT 1; pg_collation_for ------------------ "default" SELECT collation for ('foo' COLLATE "de_DE"); pg_collation_for "de_DE"
to_regclass ( text ) → regclass 将文本关系名称转换为其 OID。通过将字符串强制转换为类型 regclass 可以获得类似的结果（参见 第 8.19 节）；但是，如果找不到名称，此函数将返回 NULL 而不是引发错误。
to_regcollation ( text ) → regcollation 将文本校对名称转换为其 OID。通过将字符串强制转换为类型 regcollation 可以获得类似的结果（参见 第 8.19 节）；但是，如果找不到名称，此函数将返回 NULL 而不是引发错误。
to_regnamespace ( text ) → regnamespace 将文本模式名称转换为其 OID。通过将字符串强制转换为类型 regnamespace 可以获得类似的结果（参见 第 8.19 节）；但是，如果找不到名称，此函数将返回 NULL 而不是引发错误。
to_regoper ( text ) → regoper 将文本运算符名称转换为其 OID。将字符串强制转换为类型 regoper 可获得类似结果（请参阅第 8.19 节）；但是，如果未找到名称或名称不明确，此函数将返回 NULL，而不是引发错误。
to_regoperator ( text ) → regoperator 将文本运算符名称（带参数类型）转换为其 OID。将字符串强制转换为类型 regoperator 可获得类似结果（请参阅第 8.19 节）；但是，如果未找到名称，此函数将返回 NULL，而不是引发错误。
to_regproc ( text ) → regproc 将文本函数或过程名称转换为其 OID。将字符串强制转换为类型 regproc 可获得类似结果（请参阅第 8.19 节）；但是，如果未找到名称或名称不明确，此函数将返回 NULL，而不是引发错误。
to_regprocedure ( text ) → regprocedure 将文本函数或过程名称（带参数类型）转换为其 OID。将字符串强制转换为类型 regprocedure 可获得类似结果（请参阅第 8.19 节）；但是，如果未找到名称，此函数将返回 NULL，而不是引发错误。
to_regrole ( text ) → regrole 将文本角色名称转换为其 OID。将字符串强制转换为类型 regrole 可获得类似结果（请参阅第 8.19 节）；但是，如果未找到名称，此函数将返回 NULL，而不是引发错误。
to_regtype ( text ) → regtype 将文本类型名称转换为其 OID。将字符串强制转换为类型 regtype 可获得类似结果（请参阅第 8.19 节）；但是，如果未找到名称，此函数将返回 NULL，而不是引发错误。

大多数用于重建（反编译）数据库对象的函数都具有一个可选的*pretty标志，如果为true，则会导致结果“漂亮打印”。漂亮打印会抑制不必要的括号并添加空格以提高可读性。漂亮打印的格式更易于阅读，但默认格式更有可能被未来版本的PostgreSQL以相同的方式解释；因此，请避免将漂亮打印的输出用于转储目的。为pretty*参数传递false会产生与省略该参数相同的结果。

表 9.73. 索引列属性

名称	说明
asc	该列在正向扫描时是否按升序排列？
desc	列是否在正向扫描中按降序排序？
nulls_first	列是否在正向扫描中将 null 值排在前面？
nulls_last	列是否在正向扫描中将 null 值排在后面？
orderable	列是否具有任何已定义的排序顺序？
distance_orderable	列是否可以通过 “distance” 运算符按顺序扫描，例如 ORDER BY col <-> constant ？
returnable	列值是否可以通过仅索引扫描返回？
search_array	列是否本机支持 col = ANY(array) 搜索？
search_nulls	列是否支持 IS NULL 和 IS NOT NULL 搜索？

表 9.74。索引属性

名称	说明
clusterable	索引是否可以在 CLUSTER 命令中使用？
index_scan	索引是否支持普通（非位图）扫描？
bitmap_scan	索引是否支持位图扫描？
backward_scan	扫描方向是否可以在扫描过程中更改（以支持光标上的 FETCH BACKWARD 而无需物化）？

表 9.75。索引访问方法属性

名称	说明
can_order	访问方法是否支持 ASC、DESC 和 CREATE INDEX 中相关的关键字？
can_unique	访问方法是否支持唯一索引？
can_multi_col	访问方法是否支持具有多列的索引？
can_exclude	访问方法是否支持排除约束？
can_include	访问方法是否支持 CREATE INDEX 的 INCLUDE 子句？

表 9.76。GUC 标志

标志	说明
EXPLAIN	具有此标志的参数包含在 EXPLAIN (SETTINGS) 命令中。
NO_SHOW_ALL	具有此标志的参数从 SHOW ALL 命令中排除。
NO_RESET	带有此标志的参数不支持 RESET 命令。
NO_RESET_ALL	带有此标志的参数从 RESET ALL 命令中排除。
NOT_IN_SAMPLE	带有此标志的参数默认情况下不包含在 postgresql.conf 中。
RUNTIME_COMPUTED	带有此标志的参数是运行时计算的参数。

9.26.5. 对象信息和寻址函数#

表 9.77列出了与数据库对象标识和寻址相关的函数。

表 9.77. 对象信息和寻址函数

函数 说明
pg_describe_object ( classid oid, objid oid, objsubid integer ) → text 返回由目录 OID、对象 OID 和子对象 ID（例如表中的列号；引用整个对象时，子对象 ID 为零）标识的数据库对象的文本描述。此描述旨在供人类阅读，并且可能会根据服务器配置进行翻译。这对于确定 pg_depend 目录中引用的对象的标识特别有用。此函数为未定义的对象返回 NULL 值。
pg_identify_object ( classid oid, objid oid, objsubid integer ) → record ( type text, schema text, name text, identity text ) 返回包含足够信息以唯一标识由目录 OID、对象 OID 和子对象 ID 指定的数据库对象的行。此信息旨在供机器读取，并且绝不会翻译。 type 标识数据库对象的类型； schema 是对象所属的模式名称，或者对于不属于模式的对象类型为 NULL； name 是对象的名称，如果需要，则加上引号，如果名称（以及模式名称，如果相关）足以唯一标识对象，否则为 NULL； identity 是完整对象标识，其确切格式取决于对象类型，并且格式中的每个名称都经过模式限定并根据需要加上引号。未定义的对象用 NULL 值标识。
pg_identify_object_as_address ( classid oid, objid oid, objsubid integer ) → record ( type text, object_names text[], object_args text[] ) 返回包含足够信息的行，以唯一标识由目录 OID、对象 OID 和子对象 ID 指定的数据库对象。返回的信息独立于当前服务器，也就是说，它可用于标识另一台服务器中的同名对象。 type 标识数据库对象的类型；object_names 和 object_args 是文本数组，它们共同形成对对象的引用。这三个值可以传递给 pg_get_object_address 以获取对象的内部地址。
pg_get_object_address ( type text, object_names text[], object_args text[] ) → record ( classid oid, objid oid, objsubid integer ) 返回包含足够信息的行，以唯一标识由类型代码和对象名称和参数数组指定的数据库对象。返回的值将用于系统目录中，例如 pg_depend；它们可以传递给其他系统函数，例如 pg_describe_object 或 pg_identify_object。 classid 是包含该对象的系统目录的 OID；objid 是对象本身的 OID，如果不存在，则 objsubid 是子对象 ID，否则为零。此函数是 pg_identify_object_as_address 的逆函数。未定义的对象使用 NULL 值标识。

9.26.6. 注释信息函数#

表9.78中显示的函数提取先前使用COMMENT命令存储的注释。如果找不到指定参数的注释，则返回 null 值。

表 9.78. 注释信息函数

函数 说明
col_description ( table oid, column integer ) → text 返回表列的注释，该注释由其表的 OID 和其列号指定。（obj_description 不能用于表列，因为列没有自己的 OID。）
obj_description ( object oid, catalog name ) → text 返回由其 OID 和包含系统目录的名称指定数据库对象的注释。例如，obj_description(123456, 'pg_class') 将检索 OID 为 123456 的表的注释。
obj_description ( object oid ) → text 返回仅由其 OID 指定的数据库对象的注释。这是 已弃用，因为无法保证 OID 在不同的系统目录中是唯一的；因此，可能会返回错误的注释。
shobj_description ( object oid, catalog name ) → text 返回由其 OID 和包含系统目录的名称指定的共享数据库对象的注释。这与 obj_description 相同，只是用于检索共享对象（即数据库、角色和表空间）的注释。一些系统目录在每个集群中的所有数据库中都是全局的，并且其中对象的描述也全局存储。

9.26.7. 数据有效性检查函数#

在表 9.79中显示的函数有助于检查提议输入数据的有效性。

表 9.79. 数据有效性检查函数

函数 说明 示例
pg_input_is_valid ( string text, type text ) → boolean 测试给定的 string 是否是指定数据类型的有效输入，返回 true 或 false。 仅当数据类型的输入函数已更新为将无效输入报告为 “软” 错误时，此函数才能按预期工作。否则，无效输入将中止事务，就像直接将字符串强制转换为类型一样。 pg_input_is_valid('42', 'integer') → t pg_input_is_valid('42000000000', 'integer') → f pg_input_is_valid('1234.567', 'numeric(7,4)') → f
pg_input_error_info ( string text, type text ) → record ( message text, detail text, hint text, sql_error_code text ) 测试给定的 string 是否是指定数据类型的有效输入；如果不是，则返回将抛出的错误的详细信息。如果输入有效，则结果为 NULL。输入与 pg_input_is_valid 的输入相同。 仅当数据类型的输入函数已更新为将无效输入报告为 “软” 错误时，此函数才能按预期工作。否则，无效输入将中止事务，就像直接将字符串强制转换为类型一样。 select * from pg_input_error_info('42000000000', 'integer') → message | detail | hint | sql_error_code ------------------------------------------------------+--------+------+---------------- value "42000000000" is out of range for type integer | | | 22003 select message, detail from pg_input_error_info('1234.567', 'numeric(7,4)') → message | detail ------------------------+----------------------------------​------------------------------------------------- numeric field overflow | A field with precision 7, scale 4 must round to an absolute value less than 10^3.

9.26.8. 事务 ID 和快照信息函数#

在表 9.80中显示的函数以可导出形式提供服务器事务信息。这些函数的主要用途是确定在两个快照之间提交了哪些事务。

表 9.80. 事务 ID 和快照信息函数

函数 说明
pg_current_xact_id () → xid8 返回当前事务的 ID。如果当前事务尚未拥有一个 ID（因为它尚未执行任何数据库更新），它将分配一个新的 ID；有关详细信息，请参见 第 74.1 节。如果在子事务中执行，这将返回顶级事务 ID；有关详细信息，请参见 第 74.3 节。
pg_current_xact_id_if_assigned () → xid8 返回当前事务的 ID，或者如果尚未分配 ID，则返回 NULL。（如果事务可能是只读的，最好使用此变体，以避免不必要地消耗 XID。）如果在子事务中执行，这将返回顶级事务 ID。
pg_xact_status ( xid8 ) → text 报告最近事务的提交状态。结果之一是 in progress、committed 或 aborted，前提是事务足够新，系统保留了该事务的提交状态。如果事务足够旧，系统中没有该事务的引用，并且提交状态信息已被丢弃，则结果为 NULL。例如，应用程序可以使用此函数来确定在 COMMIT 正在进行时应用程序和数据库服务器断开连接后，事务是提交还是中止。请注意，已准备的事务报告为 in progress；如果应用程序需要确定事务 ID 是否属于已准备的事务，则必须检查 pg_prepared_xacts。
pg_current_snapshot () → pg_snapshot 返回当前 快照，这是一个数据结构，显示哪些事务 ID 现在正在进行中。快照中仅包含顶级事务 ID；不显示子事务 ID；有关详细信息，请参见 第 74.3 节。
pg_snapshot_xip ( pg_snapshot ) → setof xid8 返回快照中包含的正在进行中的事务 ID 集。
pg_snapshot_xmax ( pg_snapshot ) → xid8 返回快照的 xmax。
pg_snapshot_xmin ( pg_snapshot ) → xid8 返回快照的 xmin。
pg_visible_in_snapshot ( xid8, pg_snapshot ) → boolean 给定的事务 ID 可见吗？根据此快照（即，在获取快照之前已完成）。请注意，此函数不会针对子事务 ID (subxid) 提供正确答案；有关详细信息，请参阅第 74.3 节。

内部事务 ID 类型xid为 32 位宽，每 40 亿个事务环绕一次。但是，表 9.80中显示的函数使用 64 位类型xid8，该类型在安装期间不会环绕，并且可以在需要时通过转换转换为xid；有关详细信息，请参阅第 74.1 节。数据类型pg_snapshot存储有关特定时刻事务 ID 可见性的信息。其组件在表 9.81中进行描述。pg_snapshot的文本表示形式为*xmin*:*xmax*:*xip_list*。例如10:20:10,14,15表示xmin=10, xmax=20, xip_list=10, 14, 15。

表 9.81. 快照组件

名称	说明
xmin	仍然处于活动状态的最低事务 ID。所有小于 xmin 的事务 ID 均已提交且可见，或已回滚且已失效。
xmax	比最高已完成事务 ID 大 1。大于或等于 xmax 的所有事务 ID 在快照时间尚未完成，因此不可见。
xip_list	快照时间正在进行的事务。事务 ID 为 xmin <= X < xmax 且不在此列表中的事务已在快照时间完成，因此根据其提交状态可见或已失效。此列表不包括子事务 (subxid) 的事务 ID。

PostgreSQL13 之前的版本中没有xid8类型，因此提供了这些函数的变体，使用bigint表示 64 位 XID，并使用相应的不同的快照数据类型txid_snapshot。这些较旧的函数名称中包含txid。出于向后兼容性的考虑，它们仍然受支持，但可能会在将来的版本中删除。请参阅表 9.82。

表 9.82。已弃用的事务 ID 和快照信息函数

函数 说明
txid_current () → bigint 请参阅 pg_current_xact_id()。
txid_current_if_assigned () → bigint 请参阅 pg_current_xact_id_if_assigned()。
txid_current_snapshot () → txid_snapshot 请参阅 pg_current_snapshot()。
txid_snapshot_xip ( txid_snapshot ) → setof bigint 请参阅 pg_snapshot_xip()。
txid_snapshot_xmax ( txid_snapshot ) → bigint 请参阅 pg_snapshot_xmax()。
txid_snapshot_xmin ( txid_snapshot ) → bigint 请参阅 pg_snapshot_xmin()。
txid_visible_in_snapshot ( bigint, txid_snapshot ) → boolean 请参阅 pg_visible_in_snapshot()。
txid_status ( bigint ) → text 请参阅 pg_xact_status()。

9.26.9. 已提交事务信息函数#

表9.83中显示的函数提供有关过去事务何时提交的信息。仅当track_commit_timestamp配置选项已启用时，它们才提供有用的数据，并且仅对在启用后提交的事务提供数据。提交时间戳信息在 vacuum 期间会定期删除。

表 9.83. 已提交事务信息函数

函数 说明
pg_xact_commit_timestamp ( xid ) → 带时区的 timestamp 返回事务的提交时间戳。
pg_xact_commit_timestamp_origin ( xid ) → 记录 ( timestamp 带时区的 timestamp, roident oid) 返回事务的提交时间戳和复制源。
pg_last_committed_xact () → 记录 ( xid xid, timestamp 带时区的 timestamp, roident oid ) 返回最新提交事务的事务 ID、提交时间戳和复制源。

9.26.10. 控制数据函数#

表9.84中显示的函数打印在initdb期间初始化的信息，例如目录版本。它们还显示有关预写日志和检查点处理的信息。此信息是群集范围的，不特定于任何一个数据库。这些函数从与pg_controldata应用程序相同的信息源提供大部分相同的信息。

表 9.84. 控制数据函数

函数 说明
age ( xid ) → 整数 返回提供的交易 ID 和当前交易计数器之间的交易数。
mxid_age ( xid ) → 整数 返回提供的多事务 ID 和当前多事务计数器之间的多事务 ID 数。
pg_control_checkpoint () → 记录 返回有关当前检查点状态的信息，如 表 9.85 所示。
pg_control_system () → 记录 返回有关当前控制文件状态的信息，如 表 9.86 所示。
pg_control_init () → 记录 返回有关群集初始化状态的信息，如 表 9.87 所示。
pg_control_recovery () → 记录 返回有关恢复状态的信息，如 表 9.88 中所示。

表 9.85。pg_control_checkpoint输出列

列名称	数据类型
checkpoint_lsn	pg_lsn
redo_lsn	pg_lsn
redo_wal_file	文本
timeline_id	整数
prev_timeline_id	整数
full_page_writes	布尔值
next_xid	文本
next_oid	oid
next_multixact_id	xid
next_multi_offset	xid
oldest_xid	xid
oldest_xid_dbid	oid
oldest_active_xid	xid
oldest_multi_xid	xid
oldest_multi_dbid	oid
oldest_commit_ts_xid	xid
newest_commit_ts_xid	xid
checkpoint_time	带时区的 timestamp

表 9.86。pg_control_system输出列

列名称	数据类型
pg_control_version	整数
catalog_version_no	整数
system_identifier	bigint
pg_control_last_modified	带时区的 timestamp

表 9.87。pg_control_init输出列

列名称	数据类型
max_data_alignment	整数
database_block_size	整数
blocks_per_segment	整数
wal_block_size	整数
bytes_per_wal_segment	整数
max_identifier_length	整数
max_index_columns	整数
max_toast_chunk_size	整数
large_object_chunk_size	整数
float8_pass_by_value	布尔值
data_page_checksum_version	整数

表 9.88。pg_control_recovery输出列

列名称	数据类型
min_recovery_end_lsn	pg_lsn
min_recovery_end_timeline	整数
backup_start_lsn	pg_lsn
backup_end_lsn	pg_lsn
end_of_backup_record_required	布尔值