PostgreSQL: 文档: 17: 9.27. 系统信息函数和操作符

9.27. 系统信息函数和操作符
上一个	上	第 9. 章函数和操作符	主页	下一个

9.27.1. 会话信息函数 #

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

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

表 9.69. 会话信息函数

函数描述
`current_catalog` → `name` `current_database` () → `name` 返回当前数据库的名称。（在 SQL 标准中，数据库被称为“目录”，因此 `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，则返回 true。（例如，这对于从目录显示中排除其他会话的临时表很有用。）
`pg_jit_available` () → `boolean` 如果JIT编译器扩展可用（请参阅第 30 章）并且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`。

函数

描述

current_catalog → name

current_database () → name

返回当前数据库的名称。（在 SQL 标准中，数据库被称为“目录”，因此 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，则返回 true。（例如，这对于从目录显示中排除其他会话的临时表很有用。）

pg_jit_available () → boolean

如果JIT编译器扩展可用（请参阅第 30 章）并且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。

注意

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以测试是否持有具有授予选项的权限。此外，可以列出多个权限类型，用逗号分隔，在这种情况下，如果持有任何列出的权限，则结果将为 true。（权限字符串的大小写不重要，并且在权限名称之间但不在权限名称内允许额外的空格。）一些示例

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` `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` 和 `MAINTAIN`。
`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` 命令切换到该角色。`WITH ADMIN OPTION` 或 `WITH GRANT OPTION` 可以添加到任何这些权限类型中，以测试是否持有 `ADMIN` 权限（所有六种拼写方式测试的内容相同）。此函数不允许将 `user` 设置为 `public` 的特殊情况，因为 PUBLIC 伪角色永远不可能是真实角色的成员。
`row_security_active` ( `table` `text` 或 `oid` ) → `boolean` 在当前用户和当前环境的上下文中，是否为指定的表激活了行级安全性？

函数

描述

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 和 MAINTAIN。

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 命令切换到该角色。WITH ADMIN OPTION 或 WITH GRANT OPTION 可以添加到任何这些权限类型中，以测试是否持有 ADMIN 权限（所有六种拼写方式测试的内容相同）。此函数不允许将 user 设置为 public 的特殊情况，因为 PUBLIC 伪角色永远不可能是真实角色的成员。

row_security_active ( table text 或 oid ) → boolean

在当前用户和当前环境的上下文中，是否为指定的表激活了行级安全性？

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

表 9.71. aclitem 操作符

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

操作符

描述

示例

aclitem = aclitem → boolean

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

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

aclitem[] @> aclitem → boolean

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

'{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.72 显示了用于管理 aclitem 类型的一些其他函数。

表 9.72. aclitem 函数

函数描述
`acldefault` ( `type` `"char"`, `ownerId` `oid` ) → `aclitem[]` 构造一个 `aclitem` 数组，其中包含属于 OID 为 `ownerId` 的角色的 `type` 类型对象的默认访问权限。这表示当对象的 ACL 条目为空时将假定的访问权限。（默认访问权限在第 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` `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` 等，所有这些权限都在结果中设置。（权限字符串的大小写并不重要，并且在权限名称之间（但不在内部）允许额外的空格。）

函数

描述

acldefault ( type "char", ownerId oid ) → aclitem[]

构造一个 aclitem 数组，其中包含属于 OID 为 ownerId 的角色的 type 类型对象的默认访问权限。这表示当对象的 ACL 条目为空时将假定的访问权限。（默认访问权限在第 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 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.27.3. 模式可见性查询函数 #

表 9.73 展示了一些函数，这些函数用于判断某个对象在当前模式搜索路径中是否可见。例如，如果一个表所在的模式在搜索路径中，并且在搜索路径中没有同名的表更早出现，那么就说该表是可见的。这等价于说该表可以通过名称引用，而无需显式地指定模式。因此，要列出所有可见表的名称

SELECT relname FROM pg_class WHERE pg_table_is_visible(oid);

对于函数和操作符，如果搜索路径中较早的位置不存在具有相同名称和参数数据类型的对象，则该对象被认为是可见的。对于操作符类和族，则会同时考虑名称和关联的索引访问方法。

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

函数描述
`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` 类型（或域）在搜索路径中是否可见？

函数

描述

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.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` 为 true，则最后一个引用列是一个数组，其每个元素都应与被引用目录中的某个条目匹配。如果 `is_opt` 为 true，则允许引用列包含零而不是有效的引用。
`pg_get_constraintdef` ( `constraint` `oid` [, `pretty` `boolean` ] ) → `text` 重建约束的创建命令。（这是一个反编译的重建，而不是命令的原始文本。）
`pg_get_expr` ( `expr` `pg_node_tree`, `relation` `oid` [, `pretty` `boolean` ] ) → `text` 反编译存储在系统目录中的表达式的内部形式，例如列的默认值。如果表达式可能包含 Var，请将它们引用的关系 OID 指定为第二个参数；如果没有预期 Var，则传递零就足够了。
`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` 以在 `CREATE FUNCTION` 中出现的形式重建函数的 `RETURNS` 子句。对于过程，返回 `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` 重建分区表的分区键的定义，形式为 `CREATE TABLE` 的 `PARTITION BY` 子句中的形式。（这是一个反编译重建，不是命令的原始文本。）
`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.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 为 true，则最后一个引用列是一个数组，其每个元素都应与被引用目录中的某个条目匹配。如果 is_opt 为 true，则允许引用列包含零而不是有效的引用。

pg_get_constraintdef ( constraint oid [, pretty boolean ] ) → text

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

pg_get_expr ( expr pg_node_tree, relation oid [, pretty boolean ] ) → text

反编译存储在系统目录中的表达式的内部形式，例如列的默认值。如果表达式可能包含 Var，请将它们引用的关系 OID 指定为第二个参数；如果没有预期 Var，则传递零就足够了。

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

以在 CREATE FUNCTION 中出现的形式重建函数的 RETURNS 子句。对于过程，返回 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

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

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.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`	该列在正向扫描中是否先排序 NULL 值？
`nulls_last`	该列在正向扫描中是否后排序 NULL 值？
`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` ( `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

函数

描述

示例

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

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`	快照时正在进行的事务。满足 `xmin <= X < xmax` 且不在该列表中的事务 ID 在快照时已完成，因此根据其提交状态是可见的还是无效的。此列表不包括子事务（subxid）的事务 ID。

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

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

函数描述
`age` ( `xid` ) → `integer` 返回提供的事务 ID 和当前事务计数器之间的事务数。
`mxid_age` ( `xid` ) → `integer` 返回提供的多事务 ID 和当前多事务计数器之间的多事务 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 和当前多事务计数器之间的多事务 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 支持构建的，则返回一个表示 ICU 使用的 Unicode 版本的字符串；否则返回 `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 支持构建的，则返回一个表示 ICU 使用的 Unicode 版本的字符串；否则返回 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) 关系 fork 在相关 WAL 记录范围内被截断到 `relblocknumber` 给定的长度，或者 (b) 关系 fork 在相关 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 是在 `wal_level=minimal` 下生成的，则 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) 关系 fork 在相关 WAL 记录范围内被截断到 relblocknumber 给定的长度，或者 (b) 关系 fork 在相关 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 是在 wal_level=minimal 下生成的，则 WAL 汇总器将拒绝生成 WAL 汇总文件，因为此类摘要用作增量备份的基础是不安全的。在这种情况下，上述字段将继续前进，就像正在生成摘要一样，但不会将任何内容写入磁盘。一旦汇总器到达在 wal_level 设置为 replica 或更高时生成的 WAL，它将恢复将摘要写入磁盘。

9.27. 系统信息函数和操作符 #