PostgreSQL：文档：17：9.27. 系统信息函数和运算符

9.27. 系统信息函数和运算符
上一页	上级	第9章函数和运算符	首页	下一页

9.27.1. 会话信息函数 #

表9.69显示了一些提取会话和系统信息的函数。

除了本节中列出的函数外，还有一些与统计系统相关的函数也提供了系统信息。有关更多信息，请参阅第27.2.26节。

表9.69. 会话信息函数

函数描述
`current_catalog` → `name` `current_database` () → `name` 返回当前数据库的名称。（在SQL标准中，数据库称为““catalogs””，因此`current_catalog`是标准的拼写。）
`current_query` () → `text` 返回当前正在执行的查询的文本，如客户端提交的（可能包含多个语句）。
`current_role` → `name` 这等效于`current_user`。
`current_schema` → `name` `current_schema` () → `name` 返回搜索路径中第一个模式的名称（如果搜索路径为空，则返回空值）。这是将在不指定目标模式的情况下创建任何表或其他命名对象时使用的模式。
`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（即`pg_backend_pid`结果），即使实际的锁由子工作进程持有或等待。因此，结果中可能存在重复的PID。另请注意，当已准备的事务持有冲突锁时，它将由零进程ID表示。频繁调用此函数可能会对数据库性能产生一些影响，因为它需要在短时间内独占访问锁管理器的共享状态。
`pg_conf_load_time` () → `timestamp with time zone` 返回上次加载服务器配置文件的时间。如果当前会话当时处于活动状态，则这将是会话本身重新读取配置文件的时间（因此在不同的会话中读取会略有不同）。否则，它是postmaster进程重新读取配置文件的时间。
`pg_current_logfile` ( [ `text` ] ) → `text` 返回日志收集器当前正在使用的日志文件的路径名。该路径包含log_directory目录和各个日志文件名。如果日志收集器被禁用，则结果为`NULL`。当存在多个日志文件时，每个文件都采用不同的格式，`pg_current_logfile`在没有参数的情况下返回具有在有序列表中找到的第一个格式的文件的路径：`stderr`、`csvlog`、`jsonlog`。如果没有任何日志文件具有这些格式，则返回`NULL`。要请求有关特定日志文件格式的信息，请提供`csvlog`、`jsonlog`或`stderr`作为可选参数的值。如果在log_destination中未配置请求的日志格式，则结果为`NULL`。结果反映了`current_logfiles`文件的内容。默认情况下，此函数仅限于超级用户和具有`pg_monitor`角色权限的角色，但可以授予其他用户EXECUTE以运行该函数。
`pg_my_temp_schema` () → `oid` 返回当前会话临时模式的OID，如果没有临时模式（因为没有创建任何临时表），则返回零。
`pg_is_other_temp_schema` ( `oid` ) → `boolean` 如果给定的OID是其他会话的临时模式的OID，则返回真。（例如，这可以用于从目录显示中排除其他会话的临时表。）
`pg_jit_available` () → `boolean` 如果一个JIT编译器扩展可用（参见第 30 章）并且jit配置参数设置为`on`，则返回真。
`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`。

函数

描述

current_catalog → name

current_database () → name

返回当前数据库的名称。（在SQL标准中，数据库称为““catalogs””，因此current_catalog是标准的拼写。）

current_query () → text

返回当前正在执行的查询的文本，如客户端提交的（可能包含多个语句）。

current_role → name

这等效于current_user。

current_schema → name

current_schema () → name

返回搜索路径中第一个模式的名称（如果搜索路径为空，则返回空值）。这是将在不指定目标模式的情况下创建任何表或其他命名对象时使用的模式。

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（即pg_backend_pid结果），即使实际的锁由子工作进程持有或等待。因此，结果中可能存在重复的PID。另请注意，当已准备的事务持有冲突锁时，它将由零进程ID表示。

频繁调用此函数可能会对数据库性能产生一些影响，因为它需要在短时间内独占访问锁管理器的共享状态。

pg_conf_load_time () → timestamp with time zone

返回上次加载服务器配置文件的时间。如果当前会话当时处于活动状态，则这将是会话本身重新读取配置文件的时间（因此在不同的会话中读取会略有不同）。否则，它是postmaster进程重新读取配置文件的时间。

pg_current_logfile ( [ text ] ) → text

返回日志收集器当前正在使用的日志文件的路径名。该路径包含log_directory目录和各个日志文件名。如果日志收集器被禁用，则结果为NULL。当存在多个日志文件时，每个文件都采用不同的格式，pg_current_logfile在没有参数的情况下返回具有在有序列表中找到的第一个格式的文件的路径：stderr、csvlog、jsonlog。如果没有任何日志文件具有这些格式，则返回NULL。要请求有关特定日志文件格式的信息，请提供csvlog、jsonlog或stderr作为可选参数的值。如果在log_destination中未配置请求的日志格式，则结果为NULL。结果反映了current_logfiles文件的内容。

默认情况下，此函数仅限于超级用户和具有pg_monitor角色权限的角色，但可以授予其他用户EXECUTE以运行该函数。

pg_my_temp_schema () → oid

返回当前会话临时模式的OID，如果没有临时模式（因为没有创建任何临时表），则返回零。

pg_is_other_temp_schema ( oid ) → boolean

如果给定的OID是其他会话的临时模式的OID，则返回真。（例如，这可以用于从目录显示中排除其他会话的临时表。）

pg_jit_available () → boolean

如果一个JIT编译器扩展可用（参见第 30 章）并且jit配置参数设置为on，则返回真。

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。

注意

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.27.2. 访问权限查询函数 #

表 9.70列出了允许以编程方式查询对象访问权限的函数。（有关权限的更多信息，请参见第 5.8 节。）在这些函数中，可以按名称或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.70. 访问权限查询函数

函数描述
`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` `名称` 或 `oid`， ] `sequence` `文本` 或 `oid`， `privilege` `文本` ) → `布尔型` 用户是否对序列拥有权限？允许的权限类型包括 `USAGE`、`SELECT` 和 `UPDATE`。
`has_server_privilege` ( [ `user` `名称` 或 `oid`， ] `server` `文本` 或 `oid`， `privilege` `文本` ) → `布尔型` 用户是否对外部服务器拥有权限？唯一允许的权限类型是 `USAGE`。
`has_table_privilege` ( [ `user` `名称` 或 `oid`， ] `table` `文本` 或 `oid`， `privilege` `文本` ) → `布尔型` 用户是否对表拥有权限？允许的权限类型包括 `SELECT`、`INSERT`、`UPDATE`、`DELETE`、`TRUNCATE`、`REFERENCES`、`TRIGGER` 和 `MAINTAIN`。
`has_tablespace_privilege` ( [ `user` `名称` 或 `oid`， ] `tablespace` `文本` 或 `oid`， `privilege` `文本` ) → `布尔型` 用户是否对表空间拥有权限？唯一允许的权限类型是 `CREATE`。
`has_type_privilege` ( [ `user` `名称` 或 `oid`， ] `type` `文本` 或 `oid`， `privilege` `文本` ) → `布尔型` 用户是否对数据类型拥有权限？唯一允许的权限类型是 `USAGE`。当通过名称而不是 OID 指定类型时，允许的输入与 `regtype` 数据类型相同（参见第 8.19 节）。
`pg_has_role` ( [ `user` `名称` 或 `oid`， ] `role` `文本` 或 `oid`， `privilege` `文本` ) → `布尔型` 用户是否对角色拥有权限？允许的权限类型包括 `MEMBER`、`USAGE` 和 `SET`。`MEMBER` 表示直接或间接属于该角色，而不管授予的具体权限是什么。`USAGE` 表示角色的权限是否立即可用，而无需执行 `SET ROLE`，而 `SET` 表示是否可以使用 `SET ROLE` 命令切换到该角色。`WITH ADMIN OPTION` 或 `WITH GRANT OPTION` 可以添加到任何这些权限类型以测试是否拥有 `ADMIN` 权限（所有六种拼写都测试相同的内容）。此函数不允许将 `user` 设置为 `public` 的特殊情况，因为 PUBLIC 伪角色永远不可能是真实角色的成员。
`row_security_active` ( `table` `文本` 或 `oid` ) → `布尔型` 在当前用户和当前环境的上下文中，指定表的行级安全性是否处于活动状态？

函数

描述

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 名称 或 oid， ] sequence 文本 或 oid， privilege 文本 ) → 布尔型

用户是否对序列拥有权限？允许的权限类型包括 USAGE、SELECT 和 UPDATE。

has_server_privilege ( [ user 名称 或 oid， ] server 文本 或 oid， privilege 文本 ) → 布尔型

用户是否对外部服务器拥有权限？唯一允许的权限类型是 USAGE。

has_table_privilege ( [ user 名称 或 oid， ] table 文本 或 oid， privilege 文本 ) → 布尔型

用户是否对表拥有权限？允许的权限类型包括 SELECT、INSERT、UPDATE、DELETE、TRUNCATE、REFERENCES、TRIGGER 和 MAINTAIN。

has_tablespace_privilege ( [ user 名称 或 oid， ] tablespace 文本 或 oid， privilege 文本 ) → 布尔型

用户是否对表空间拥有权限？唯一允许的权限类型是 CREATE。

has_type_privilege ( [ user 名称 或 oid， ] type 文本 或 oid， privilege 文本 ) → 布尔型

用户是否对数据类型拥有权限？唯一允许的权限类型是 USAGE。当通过名称而不是 OID 指定类型时，允许的输入与 regtype 数据类型相同（参见第 8.19 节）。

pg_has_role ( [ user 名称 或 oid， ] role 文本 或 oid， privilege 文本 ) → 布尔型

用户是否对角色拥有权限？允许的权限类型包括 MEMBER、USAGE 和 SET。MEMBER 表示直接或间接属于该角色，而不管授予的具体权限是什么。USAGE 表示角色的权限是否立即可用，而无需执行 SET ROLE，而 SET 表示是否可以使用 SET ROLE 命令切换到该角色。WITH ADMIN OPTION 或 WITH GRANT OPTION 可以添加到任何这些权限类型以测试是否拥有 ADMIN 权限（所有六种拼写都测试相同的内容）。此函数不允许将 user 设置为 public 的特殊情况，因为 PUBLIC 伪角色永远不可能是真实角色的成员。

row_security_active ( table 文本 或 oid ) → 布尔型

在当前用户和当前环境的上下文中，指定表的行级安全性是否处于活动状态？

表 9.71 显示了可用于 aclitem 类型的运算符，它是访问权限的目录表示。有关如何读取访问权限值的更多信息，请参见第 5.8 节。

表 9.71. aclitem 运算符

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

运算符

描述

示例

aclitem = aclitem → 布尔型

aclitem 是否相等？（请注意，类型 aclitem 缺少通常的一组比较运算符；它只有相等性。反过来，aclitem 数组只能比较是否相等。）

'calvin=r*w/hobbes'::aclitem = 'calvin=r*w*/hobbes'::aclitem → f

aclitem[] @> aclitem → 布尔型

数组是否包含指定的权限？（如果存在与 aclitem 的授予者和授权者匹配的数组条目，并且至少具有指定的权限集，则为真。）

'{calvin=r*w/hobbes,hobbes=r*w*/postgres}'::aclitem[] @> 'calvin=r*/hobbes'::aclitem → t

aclitem[] ~ aclitem → 布尔型

这是 @> 的已弃用别名。

'{calvin=r*w/hobbes,hobbes=r*w*/postgres}'::aclitem[] ~ 'calvin=r*/hobbes'::aclitem → t

表 9.72 显示了一些其他函数来管理 aclitem 类型。

表 9.72. aclitem 函数

函数描述
`acldefault` ( `type` `"字符"`， `ownerId` `oid` ) → `aclitem[]` 构造一个 `aclitem` 数组，其中包含属于 OID 为 `ownerId` 的角色的类型为 `type` 的对象的默认访问权限。这表示当对象的 ACL 条目为 null 时将采用的访问权限。（默认访问权限在第 5.8 节中进行了描述。）`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` `文本`， `is_grantable` `布尔型` ) 将 `aclitem` 数组作为一组行返回。如果授予者是伪角色 PUBLIC，则在 `grantee` 列中以零表示。每个授予的权限都表示为 `SELECT`、`INSERT` 等（有关完整列表，请参见表 5.1）。请注意，每个权限都被分解为单独的一行，因此 `privilege_type` 列中只出现一个关键字。
`makeaclitem` ( `grantee` `oid`， `grantor` `oid`， `privileges` `文本`， `is_grantable` `布尔型` ) → `aclitem` 使用给定的属性构造一个 `aclitem`。`privileges` 是一个用逗号分隔的权限名称列表，例如 `SELECT`、`INSERT` 等，所有这些权限都在结果中设置。（权限字符串的大小写不敏感，在权限名称之间允许额外的空格，但在权限名称内部不允许。）

函数

描述

acldefault ( type "字符"， ownerId oid ) → aclitem[]

构造一个 aclitem 数组，其中包含属于 OID 为 ownerId 的角色的类型为 type 的对象的默认访问权限。这表示当对象的 ACL 条目为 null 时将采用的访问权限。（默认访问权限在第 5.8 节中进行了描述。）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 文本， is_grantable 布尔型 )

将 aclitem 数组作为一组行返回。如果授予者是伪角色 PUBLIC，则在 grantee 列中以零表示。每个授予的权限都表示为 SELECT、INSERT 等（有关完整列表，请参见表 5.1）。请注意，每个权限都被分解为单独的一行，因此 privilege_type 列中只出现一个关键字。

makeaclitem ( grantee oid， grantor oid， privileges 文本， is_grantable 布尔型 ) → aclitem

使用给定的属性构造一个 aclitem。privileges 是一个用逗号分隔的权限名称列表，例如 SELECT、INSERT 等，所有这些权限都在结果中设置。（权限字符串的大小写不敏感，在权限名称之间允许额外的空格，但在权限名称内部不允许。）

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

表 9.73 显示了确定某个对象在当前模式搜索路径中是否可见的函数。例如，如果表的包含模式在搜索路径中，并且在搜索路径中没有相同名称的表出现在更前面，则该表被称为可见。这等效于以下语句：该表可以在没有显式模式限定的情况下通过名称引用。因此，要列出所有可见表的名称

SELECT relname FROM pg_class WHERE pg_table_is_visible(oid);

对于函数和运算符，如果搜索路径中没有相同名称和参数数据类型的对象出现在更前面，则认为该对象在搜索路径中可见。对于运算符类和族，名称和关联的索引访问方法都会被考虑。

表 9.73. 模式可见性查询函数

函数描述
`pg_collation_is_visible` ( `collation` `oid` ) → `布尔型` 排序规则在搜索路径中是否可见？
`pg_conversion_is_visible` ( `conversion` `oid` ) → `布尔型` 转换在搜索路径中是否可见？
`pg_function_is_visible` ( `function` `oid` ) → `布尔型` 函数在搜索路径中是否可见？（这对于过程和聚合也适用。）
`pg_opclass_is_visible` ( `opclass` `oid` ) → `布尔型` 运算符类在搜索路径中是否可见？
`pg_operator_is_visible` ( `operator` `oid` ) → `布尔型` 运算符在搜索路径中是否可见？
`pg_opfamily_is_visible` ( `opclass` `oid` ) → `布尔型` 运算符族在搜索路径中是否可见？
`pg_statistics_obj_is_visible` ( `stat` `oid` ) → `布尔型` 统计对象在搜索路径中是否可见？
`pg_table_is_visible` ( `table` `oid` ) → `布尔型` 表在搜索路径中是否可见？（这适用于所有类型的关系，包括视图、物化视图、索引、序列和外部表。）
`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` 类型（或域）在搜索路径中可见吗？

函数

描述

pg_collation_is_visible ( collation oid ) → 布尔型

排序规则在搜索路径中是否可见？

pg_conversion_is_visible ( conversion oid ) → 布尔型

转换在搜索路径中是否可见？

pg_function_is_visible ( function oid ) → 布尔型

函数在搜索路径中是否可见？（这对于过程和聚合也适用。）

pg_opclass_is_visible ( opclass oid ) → 布尔型

运算符类在搜索路径中是否可见？

pg_operator_is_visible ( operator oid ) → 布尔型

运算符在搜索路径中是否可见？

pg_opfamily_is_visible ( opclass oid ) → 布尔型

运算符族在搜索路径中是否可见？

pg_statistics_obj_is_visible ( stat oid ) → 布尔型

统计对象在搜索路径中是否可见？

pg_table_is_visible ( table oid ) → 布尔型

表在搜索路径中是否可见？（这适用于所有类型的关系，包括视图、物化视图、索引、序列和外部表。）

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.27.4. 系统目录信息函数 #

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

表 9.74. 系统目录信息函数

函数描述
`format_type` ( `type` `oid`, `typemod` `integer` ) → `text` 返回由其类型 OID 和可能的类型修饰符标识的数据类型的 SQL 名称。如果不知道特定的修饰符，则将 NULL 传递给类型修饰符。
`pg_basetype` ( `regtype` ) → `regtype` 返回由其类型 OID 标识的域的基本类型的 OID。如果参数是非域类型的 OID，则按原样返回参数。如果参数不是有效的类型 OID，则返回 NULL。如果存在域依赖项链，它将递归直到找到基本类型。假设 `CREATE DOMAIN mytext AS text` `pg_basetype('mytext'::regtype)` → `text`
`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` 列表中的 “裸” 列标签，或者 `false`，如果它只能在 `AS` 后使用。`catdesc` 列包含可能已本地化的字符串，描述关键字的类别。`baredesc` 列包含可能已本地化的字符串，描述关键字的列标签状态。
`pg_get_partkeydef` ( `table` `oid` ) → `text` 重建分区表的 partition key 的定义，以其在 `CREATE TABLE` 的 `PARTITION BY` 子句中的形式。（这是一个反编译的重建，而不是命令的原始文本。）
`pg_get_ruledef` ( `rule` `oid` [, `pretty` `boolean` ] ) → `text` 重建规则的创建命令。（这是一个反编译的重建，而不是命令的原始文本。）
`pg_get_serial_sequence` ( `table` `text`, `column` `text` ) → `text` 返回与列关联的序列的名称，如果列没有关联序列则返回 NULL。如果列是 identity 列，则关联的序列是为此列内部创建的序列。对于使用 serial 类型之一（`serial`、`smallserial`、`bigserial`）创建的列，它是为此 serial 列定义创建的序列。在后一种情况下，可以使用 `ALTER SEQUENCE OWNED BY` 修改或删除关联。（此函数可能应该称为 `pg_get_owned_sequence`；其当前名称反映了它在历史上一直用于 serial 类型列的事实。）第一个参数是带有可选模式的表名，第二个参数是列名。因为第一个参数可能包含模式和表名，所以它按通常的 SQL 规则解析，这意味着它默认情况下会被小写。第二个参数，仅仅是一个列名，被逐字处理，因此保留其大小写。结果适合格式化以传递给序列函数（参见第 9.17 节）。一个典型的用法是在读取 identity 或 serial 列的序列的当前值，例如 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` 重构视图或物化视图的基础 `SELECT` 命令，使用视图的文本名称而不是其 OID。（已弃用；请改用 OID 变体。）
`pg_index_column_has_property` ( `index` `regclass`, `column` `integer`, `property` `text` ) → `boolean` 测试索引列是否具有指定的属性。常见的索引列属性列在表 9.75中。（请注意，扩展访问方法可以为其索引定义其他属性名称。）如果属性名称未知或不适用于特定对象，或者如果 OID 或列号未识别有效对象，则返回 `NULL`。
`pg_index_has_property` ( `index` `regclass`, `property` `text` ) → `boolean` 测试索引是否具有指定的属性。常见的索引属性列在表 9.76中。（请注意，扩展访问方法可以为其索引定义其他属性名称。）如果属性名称未知或不适用于特定对象，或者如果 OID 未识别有效对象，则返回 `NULL`。
`pg_indexam_has_property` ( `am` `oid`, `property` `text` ) → `boolean` 测试索引访问方法是否具有指定的属性。访问方法属性列在表 9.77中。如果属性名称未知或不适用于特定对象，或者如果 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 关联的标志数组，如果 GUC 不存在则返回 `NULL`。如果 GUC 存在但没有要显示的标志，则结果为空数组。仅公开表 9.78中列出的最有用的标志。
`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 相同，用于比较目的，但显示为类型名称。 `pg_typeof(33)` → `integer`
`COLLATION FOR` ( `"any"` ) → `text` 返回传递给它的值的排序规则名称。如果需要，该值将被引用并限定模式。如果未为参数表达式派生任何排序规则，则返回 `NULL`。如果参数不是可排序规则的数据类型，则会引发错误。 `collation for ('foo'::text)` → `"default"` `collation for ('foo' COLLATE "de_DE")` → `"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。字符串中的语法错误会导致错误；但如果字符串是语法上有效的类型名称，但恰好在目录中找不到，则结果为 `NULL`。通过将字符串转换为 `regtype` 类型可以获得类似的结果（参见第 8.19 节），除了对于找不到的名称，它会抛出错误。
`to_regtypemod` ( `text` ) → `integer` 解析文本字符串，从中提取潜在的类型名称，并转换其类型修饰符（如果有）。字符串中的语法错误会导致错误；但如果字符串是语法上有效的类型名称，但恰好在目录中找不到，则结果为 `NULL`。如果不存在类型修饰符，则结果为 `-1`。 `to_regtypemod` 可以与 to_regtype 结合使用，为 format_type 生成合适的输入，从而规范化表示类型名称的字符串。 `format_type(to_regtype('varchar(32)'), to_regtypemod('varchar(32)'))` → `character varying(32)`

函数

描述

format_type ( type oid, typemod integer ) → text

返回由其类型 OID 和可能的类型修饰符标识的数据类型的 SQL 名称。如果不知道特定的修饰符，则将 NULL 传递给类型修饰符。

pg_basetype ( regtype ) → regtype

返回由其类型 OID 标识的域的基本类型的 OID。如果参数是非域类型的 OID，则按原样返回参数。如果参数不是有效的类型 OID，则返回 NULL。如果存在域依赖项链，它将递归直到找到基本类型。

假设 CREATE DOMAIN mytext AS text

pg_basetype('mytext'::regtype) → text

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 列表中的 “裸” 列标签，或者 false，如果它只能在 AS 后使用。catdesc 列包含可能已本地化的字符串，描述关键字的类别。baredesc 列包含可能已本地化的字符串，描述关键字的列标签状态。

pg_get_partkeydef ( table oid ) → text

重建分区表的 partition key 的定义，以其在 CREATE TABLE 的 PARTITION BY 子句中的形式。（这是一个反编译的重建，而不是命令的原始文本。）

pg_get_ruledef ( rule oid [, pretty boolean ] ) → text

重建规则的创建命令。（这是一个反编译的重建，而不是命令的原始文本。）

pg_get_serial_sequence ( table text, column text ) → text

返回与列关联的序列的名称，如果列没有关联序列则返回 NULL。如果列是 identity 列，则关联的序列是为此列内部创建的序列。对于使用 serial 类型之一（serial、smallserial、bigserial）创建的列，它是为此 serial 列定义创建的序列。在后一种情况下，可以使用 ALTER SEQUENCE OWNED BY 修改或删除关联。（此函数可能应该称为 pg_get_owned_sequence；其当前名称反映了它在历史上一直用于 serial 类型列的事实。）第一个参数是带有可选模式的表名，第二个参数是列名。因为第一个参数可能包含模式和表名，所以它按通常的 SQL 规则解析，这意味着它默认情况下会被小写。第二个参数，仅仅是一个列名，被逐字处理，因此保留其大小写。结果适合格式化以传递给序列函数（参见第 9.17 节）。

一个典型的用法是在读取 identity 或 serial 列的序列的当前值，例如

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

重构视图或物化视图的基础 SELECT 命令，使用视图的文本名称而不是其 OID。（已弃用；请改用 OID 变体。）

pg_index_column_has_property ( index regclass, column integer, property text ) → boolean

测试索引列是否具有指定的属性。常见的索引列属性列在表 9.75中。（请注意，扩展访问方法可以为其索引定义其他属性名称。）如果属性名称未知或不适用于特定对象，或者如果 OID 或列号未识别有效对象，则返回 NULL。

pg_index_has_property ( index regclass, property text ) → boolean

测试索引是否具有指定的属性。常见的索引属性列在表 9.76中。（请注意，扩展访问方法可以为其索引定义其他属性名称。）如果属性名称未知或不适用于特定对象，或者如果 OID 未识别有效对象，则返回 NULL。

pg_indexam_has_property ( am oid, property text ) → boolean

测试索引访问方法是否具有指定的属性。访问方法属性列在表 9.77中。如果属性名称未知或不适用于特定对象，或者如果 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 关联的标志数组，如果 GUC 不存在则返回 NULL。如果 GUC 存在但没有要显示的标志，则结果为空数组。仅公开表 9.78中列出的最有用的标志。

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 相同，用于比较目的，但显示为类型名称。

pg_typeof(33) → integer

COLLATION FOR ( "any" ) → text

返回传递给它的值的排序规则名称。如果需要，该值将被引用并限定模式。如果未为参数表达式派生任何排序规则，则返回 NULL。如果参数不是可排序规则的数据类型，则会引发错误。

collation for ('foo'::text) → "default"

collation for ('foo' COLLATE "de_DE") → "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。字符串中的语法错误会导致错误；但如果字符串是语法上有效的类型名称，但恰好在目录中找不到，则结果为 NULL。通过将字符串转换为 regtype 类型可以获得类似的结果（参见第 8.19 节），除了对于找不到的名称，它会抛出错误。

to_regtypemod ( text ) → integer

解析文本字符串，从中提取潜在的类型名称，并转换其类型修饰符（如果有）。字符串中的语法错误会导致错误；但如果字符串是语法上有效的类型名称，但恰好在目录中找不到，则结果为 NULL。如果不存在类型修饰符，则结果为 -1。

to_regtypemod 可以与 to_regtype 结合使用，为 format_type 生成合适的输入，从而规范化表示类型名称的字符串。

format_type(to_regtype('varchar(32)'), to_regtypemod('varchar(32)')) → character varying(32)

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

表 9.75. 索引列属性

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

表 9.76. 索引属性

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

表 9.77. 索引访问方法属性

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

表 9.78. 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.27.5. 对象信息和寻址函数 #

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

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

函数描述
`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` 值进行标识。

函数

描述

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.27.6. 注释信息函数 #

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

表 9.80. 注释信息函数

函数描述
`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` 类似，只是它用于检索共享对象（即数据库、角色和表空间）的注释。某些系统目录在每个集群中的所有数据库中都是全局的，并且其中对象的描述也全局存储。

函数

描述

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.27.7. 数据有效性检查函数 #

表 9.81 中显示的函数可用于检查建议的输入数据的有效性。

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

函数描述示例
`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` ( `字符串` `text`, `类型` `text` ) → `record` ( `message` `text`, `detail` `text`, `hint` `text`, `sql_error_code` `text` ) 测试给定的 `字符串` 是否为指定数据类型的有效输入；如果不是，则返回本应抛出的错误的详细信息。如果输入有效，则结果为 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

函数

描述

示例

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 ( 字符串 text, 类型 text ) → record ( message text, detail text, hint text, sql_error_code text )

测试给定的 字符串 是否为指定数据类型的有效输入；如果不是，则返回本应抛出的错误的详细信息。如果输入有效，则结果为 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

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

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

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

函数描述
`pg_current_xact_id` () → `xid8` 返回当前事务的 ID。如果当前事务还没有 ID（因为它尚未执行任何数据库更新），它将分配一个新的 ID；有关详细信息，请参见第 66.1 节。如果在子事务中执行，这将返回顶级事务 ID；有关详细信息，请参见第 66.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；有关详细信息，请参见第 66.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) 提供正确的答案；有关详细信息，请参见第 66.3 节。

函数

描述

pg_current_xact_id () → xid8

返回当前事务的 ID。如果当前事务还没有 ID（因为它尚未执行任何数据库更新），它将分配一个新的 ID；有关详细信息，请参见第 66.1 节。如果在子事务中执行，这将返回顶级事务 ID；有关详细信息，请参见第 66.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；有关详细信息，请参见第 66.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) 提供正确的答案；有关详细信息，请参见第 66.3 节。

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

表 9.83. 快照组件

名称	描述
`xmin`	仍然处于活动状态的最低事务 ID。小于 `xmin` 的所有事务 ID 都是已提交且可见的，或者已回滚且已失效。
`xmax`	已完成事务 ID 的最大值加一。在快照时间点，所有大于或等于 `xmax` 的事务 ID 尚未完成，因此不可见。
`xip_list`	快照时间点正在进行的事务。不在此列表中的事务 ID 且 `xmin <= X < xmax` 的事务已在快照时间点完成，因此根据其提交状态可见或已失效。此列表不包含子事务的事务 ID (subxid)。

在版本 13 之前的 PostgreSQL 版本中，没有 xid8 类型，因此提供了使用 bigint 表示 64 位 XID 的这些函数的变体，以及相应的不同快照数据类型 txid_snapshot。这些旧函数在其名称中包含 txid。它们仍然支持向后兼容，但可能会从将来的版本中删除。请参见表 9.84。

表 9.84. 已弃用的事务 ID 和快照信息函数

函数描述
`age` ( `xid` ) → `integer` 返回提供的事务 ID 和当前事务计数器之间的事务数。
`mxid_age` ( `xid` ) → `integer` 返回提供的多事务 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()`。

函数

描述

age ( xid ) → integer

返回提供的事务 ID 和当前事务计数器之间的事务数。

mxid_age ( xid ) → integer

返回提供的多事务 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.27.9. 已提交事务信息函数 #

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

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

函数描述
`pg_xact_commit_timestamp` ( `xid` ) → `timestamp with time zone` 返回事务的提交时间戳。
`pg_xact_commit_timestamp_origin` ( `xid` ) → `record` ( `timestamp` `timestamp with time zone`, `roident` `oid`) 返回事务的提交时间戳和复制源。
`pg_last_committed_xact` () → `record` ( `xid` `xid`, `timestamp` `timestamp with time zone`, `roident` `oid` ) 返回最新已提交事务的事务 ID、提交时间戳和复制源。

函数

描述

pg_xact_commit_timestamp ( xid ) → timestamp with time zone

返回事务的提交时间戳。

pg_xact_commit_timestamp_origin ( xid ) → record ( timestamp timestamp with time zone, roident oid)

返回事务的提交时间戳和复制源。

pg_last_committed_xact () → record ( xid xid, timestamp timestamp with time zone, roident oid )

返回最新已提交事务的事务 ID、提交时间戳和复制源。

9.27.10. 控制数据函数 #

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

表 9.86. 控制数据函数

函数描述
`pg_control_checkpoint` () → `record` 返回有关当前检查点状态的信息，如表 9.87所示。
`pg_control_system` () → `record` 返回有关当前控制文件状态的信息，如表 9.88所示。
`pg_control_init` () → `record` 返回有关集群初始化状态的信息，如表 9.89所示。
`pg_control_recovery` () → `record` 返回有关恢复状态的信息，如表 9.90所示。

函数

描述

pg_control_checkpoint () → record

返回有关当前检查点状态的信息，如表 9.87所示。

pg_control_system () → record

返回有关当前控制文件状态的信息，如表 9.88所示。

pg_control_init () → record

返回有关集群初始化状态的信息，如表 9.89所示。

pg_control_recovery () → record

返回有关恢复状态的信息，如表 9.90所示。

表 9.87. pg_control_checkpoint 输出列

列名	数据类型
`checkpoint_lsn`	`pg_lsn`
`redo_lsn`	`pg_lsn`
`redo_wal_file`	`text`
`timeline_id`	`integer`
`prev_timeline_id`	`integer`
`full_page_writes`	`boolean`
`next_xid`	`text`
`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 with time zone`

表 9.88. pg_control_system 输出列

列名	数据类型
`pg_control_version`	`integer`
`catalog_version_no`	`integer`
`system_identifier`	`bigint`
`pg_control_last_modified`	`timestamp with time zone`

表 9.89. pg_control_init 输出列

列名	数据类型
`max_data_alignment`	`integer`
`database_block_size`	`integer`
`blocks_per_segment`	`integer`
`wal_block_size`	`integer`
`bytes_per_wal_segment`	`integer`
`max_identifier_length`	`integer`
`max_index_columns`	`integer`
`max_toast_chunk_size`	`integer`
`large_object_chunk_size`	`integer`
`float8_pass_by_value`	`boolean`
`data_page_checksum_version`	`integer`

表 9.90. pg_control_recovery 输出列

列名	数据类型
`min_recovery_end_lsn`	`pg_lsn`
`min_recovery_end_timeline`	`integer`
`backup_start_lsn`	`pg_lsn`
`backup_end_lsn`	`pg_lsn`
`end_of_backup_record_required`	`boolean`

9.27.11. 版本信息函数 #

在表 9.91中显示的函数打印版本信息。

表 9.91. 版本信息函数

函数描述
`version` () → `text` 返回一个描述PostgreSQL服务器版本的字符串。您还可以从server_version获取此信息，或者对于机器可读版本，使用server_version_num。软件开发人员应该使用`server_version_num`（从 8.2 开始可用）或`PQserverVersion`，而不是解析文本版本。
`unicode_version` () → `text` 返回一个表示PostgreSQL使用的 Unicode 版本的字符串。
`icu_unicode_version` () → `text` 返回一个表示 ICU 使用的 Unicode 版本的字符串，如果服务器是在启用 ICU 支持的情况下构建的；否则返回`NULL`

函数

描述

version () → text

返回一个描述PostgreSQL服务器版本的字符串。您还可以从server_version获取此信息，或者对于机器可读版本，使用server_version_num。软件开发人员应该使用server_version_num（从 8.2 开始可用）或PQserverVersion，而不是解析文本版本。

unicode_version () → text

返回一个表示PostgreSQL使用的 Unicode 版本的字符串。

icu_unicode_version () → text

返回一个表示 ICU 使用的 Unicode 版本的字符串，如果服务器是在启用 ICU 支持的情况下构建的；否则返回NULL

9.27.12. WAL 摘要信息函数 #

在表 9.92中显示的函数打印有关 WAL 摘要状态的信息。参见summarize_wal。

表 9.92. WAL 摘要信息函数

函数描述
`pg_available_wal_summaries` () → `setof record` ( `tli` `bigint`, `start_lsn` `pg_lsn`, `end_lsn` `pg_lsn` ) 返回有关数据目录中（在`pg_wal/summaries`下）存在的 WAL 摘要文件的信息。每个 WAL 摘要文件将返回一行。每个文件总结在指示的 TLI 上在指示的 LSN 范围内生成的 WAL。此函数可能有助于确定服务器上是否存在足够的 WAL 摘要，以便基于某些先前备份（已知其起始 LSN）进行增量备份。
`pg_wal_summary_contents` ( `tli` `bigint`, `start_lsn` `pg_lsn`, `end_lsn` `pg_lsn` ) → `setof record` ( `relfilenode` `oid`, `reltablespace` `oid`, `reldatabase` `oid`, `relforknumber` `smallint`, `relblocknumber` `bigint`, `is_limit_block` `boolean` ) 返回有关由 TLI 和起始和结束 LSN 标识的单个 WAL 摘要文件内容的信息。每行`is_limit_block`为 false 表示由其余输出列标识的块至少被此文件中摘要的记录范围内的至少一个 WAL 记录修改过。每行`is_limit_block`为 true 表示 (a) 关系分支被截断到由`relblocknumber`给定的长度，在相关的 WAL 记录范围内或 (b) 关系分支在相关的 WAL 记录范围内创建或删除；在这种情况下，`relblocknumber`将为零。
`pg_get_wal_summarizer_state` () → `record` ( `summarized_tli` `bigint`, `summarized_lsn` `pg_lsn`, `pending_lsn` `pg_lsn`, `summarizer_pid` `int` ) 返回有关 WAL 摘要程序进度的信息。如果 WAL 摘要程序自实例启动以来从未运行过，则`summarized_tli`和`summarized_lsn`将分别为`0`和`0/0`；否则，它们将是写入磁盘的最后一个 WAL 摘要文件的 TLI 和结束 LSN。如果 WAL 摘要程序当前正在运行，则`pending_lsn`将是它已消耗的最后一个记录的结束 LSN，它必须始终大于或等于`summarized_lsn`；如果 WAL 摘要程序未运行，则它将等于`summarized_lsn`。`summarizer_pid`是 WAL 摘要程序进程的 PID，如果它正在运行，否则为 NULL。作为特殊例外，如果在`wal_level=minimal`下生成的 WAL 上运行，则 WAL 摘要程序将拒绝生成 WAL 摘要文件，因为此类摘要不安全用作增量备份的基础。在这种情况下，上述字段将继续前进，就像正在生成摘要一样，但不会写入磁盘。一旦摘要程序到达在`wal_level`设置为`replica`或更高时生成的 WAL，它将恢复将摘要写入磁盘。

函数

描述

pg_available_wal_summaries () → setof record ( tli bigint, start_lsn pg_lsn, end_lsn pg_lsn )

返回有关数据目录中（在pg_wal/summaries下）存在的 WAL 摘要文件的信息。每个 WAL 摘要文件将返回一行。每个文件总结在指示的 TLI 上在指示的 LSN 范围内生成的 WAL。此函数可能有助于确定服务器上是否存在足够的 WAL 摘要，以便基于某些先前备份（已知其起始 LSN）进行增量备份。

pg_wal_summary_contents ( tli bigint, start_lsn pg_lsn, end_lsn pg_lsn ) → setof record ( relfilenode oid, reltablespace oid, reldatabase oid, relforknumber smallint, relblocknumber bigint, is_limit_block boolean )

返回有关由 TLI 和起始和结束 LSN 标识的单个 WAL 摘要文件内容的信息。每行is_limit_block为 false 表示由其余输出列标识的块至少被此文件中摘要的记录范围内的至少一个 WAL 记录修改过。每行is_limit_block为 true 表示 (a) 关系分支被截断到由relblocknumber给定的长度，在相关的 WAL 记录范围内或 (b) 关系分支在相关的 WAL 记录范围内创建或删除；在这种情况下，relblocknumber将为零。

pg_get_wal_summarizer_state () → record ( summarized_tli bigint, summarized_lsn pg_lsn, pending_lsn pg_lsn, summarizer_pid int )

返回有关 WAL 摘要程序进度的信息。如果 WAL 摘要程序自实例启动以来从未运行过，则summarized_tli和summarized_lsn将分别为0和0/0；否则，它们将是写入磁盘的最后一个 WAL 摘要文件的 TLI 和结束 LSN。如果 WAL 摘要程序当前正在运行，则pending_lsn将是它已消耗的最后一个记录的结束 LSN，它必须始终大于或等于summarized_lsn；如果 WAL 摘要程序未运行，则它将等于summarized_lsn。summarizer_pid是 WAL 摘要程序进程的 PID，如果它正在运行，否则为 NULL。

作为特殊例外，如果在wal_level=minimal下生成的 WAL 上运行，则 WAL 摘要程序将拒绝生成 WAL 摘要文件，因为此类摘要不安全用作增量备份的基础。在这种情况下，上述字段将继续前进，就像正在生成摘要一样，但不会写入磁盘。一旦摘要程序到达在wal_level设置为replica或更高时生成的 WAL，它将恢复将摘要写入磁盘。

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