系统信息函数

PostgreSQL 9.6.0 手册
上一页	上一级	章 9. 函数和操作符	下一页

---

9.25. 系统信息函数

表 9-59展示了多个可以抽取会话和系统信息的函数。

除了本节列出的函数，还有一些与统计系统相关的函数也提供系统信息。详见第 28.2.2 节。

session_user通常是发起当前数据库连接的用户，不过超级用户可以用SET SESSION AUTHORIZATION修改这个设置。current_user是用于权限检查的用户标识。通常， 它总是等于会话用户，但是可以被SET ROLE改变。它也会在函数执行的过程中随着属性SECURITY DEFINER的改变而改变。在 Unix 的说法里，那么会话用户是"真实用户"，而当前用户是"有效用户"。

current_schema返回在搜索路径中的第一个模式名（如果搜索路径是空则返回空值）。 如果创建表或者其它命名对象时没有声明目标模式，那么它将是被用于这些对象的模式。current_schemas(boolean)返回一个在搜索路径中出现的所有模式名的数组。布尔选项决定pg_catalog这样的隐式包含的系统模式是否包含在返回的搜索路径中。

inet_client_addr返回当前客户端的 IP 地址，inet_client_port返回它的端口号。 inet_server_addr返回接受当前连接的服务器的 IP 地址，而inet_server_port返回对应的端口号。如果连接是通过 Unix 域套接字进行的，那么所有这些函数都返回 NULL。

pg_blocking_pids返回一个进程 ID 的数组， 数组中的进程中的会话阻塞了指定进程 ID 所代表的服务器进程， 如果指定的服务器进程不存在或者没有被阻塞则返回空数组。 如果一个进程持有与另一个进程加锁请求冲突的锁（硬锁）， 或者前者正在等待一个与后者加锁请求冲突的锁并且前者在该锁的等待队列中 位于后者的前面（软锁），则前者会阻塞后者。在使用并行查询时， 这个函数的结果总是会列出客户端可见的进程 ID（即pg_backend_pid 的结果），即便实际的锁是由工作者进程所持有或者等待也是如此。 这样造成的后果是，结果中可能会有很多重复的 PID。 还要注意当一个预备事务持有一个冲突锁时， 这个函数的结果中它将被表示为一个为零的进程 ID。 对这个函数的频繁调用可能对数据库性能有一些影响， 因为它需要短时间地独占访问锁管理器的共享状态。

pg_conf_load_time返回服务器配置文件最近被载入的 timestamp with time zone（如果当前会话在那时就已经存在， 这个值将是该会话自己重新读取配置文件的时间， 因此在不同的会话中这个读数会有一点变化。如果不是这样， 这个值就是 postmaster 进程重读配置文件的时间）。

pg_my_temp_schema返回当前会话临时模式的 OID，如果没有使用临时模式（因为它没有创建任何临时表）则返回零。如果给定的 OID 是另一个会话的临时模式的 OID，则pg_is_other_temp_schema返回真（这是有用的，例如，要将其他会话的临时表从一个目录显示中排除）。

pg_listening_channels 返回当前会话正在监听的异步通知频道的名称的集合。 pg_notification_queue_usage 返回等待处理的通知占可用的通知空间的比例， 它是一个 0-1 范围内的double值。详见 LISTEN和NOTIFY。

pg_postmaster_start_time返回服务器启动时的timestamp with time zone。

version返回一个描述 PostgreSQL服务器版本的字符串。 你也可以从server_version获取机器 可读版本server_version_num信息， 软件开发者应该使用server_version_num (8.2可用)或者 PQserverVersion 解析文本版本。

表 9-60列出那些允许用户编程查询对象访问权限的函数。参阅第 5.6 节获取更多有关权限的信息。

has_table_privilege判断一个用户是否可以用某种特定的方式访问一个表。 该用户可以通过名字或者 OID （pg_authid.oid） 来指定，也可以用public表示 PUBLIC 伪角色。如果省略该参数，则使用current_user。 该表可以通过名字或者 OID 指定（因此，实际上有六种 has_table_privilege的变体，我们可以通过它们的参数数目和类型来区分它们） 。如果用名字指定，那么在必要时该名字可以是模式限定的。 所希望的权限类型是用一个文本串来指定的，它必须是下面的几个值之一： SELECT、INSERT、UPDATE、DELETE、TRUNCATE、REFERENCES或TRIGGER。WITH GRANT OPTION可以被选择增加到一个权限类型来测试是否该权限是使用转授选项得到。另外，可以使用逗号分隔来列出多个权限类型，在这种情况下只要具有其中之一的权限则结果为真（权限字符串的大小写并不重要，可以在权限名称之间出现额外的空白，但是在权限名内部不能有空白）。一些例子：

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

has_sequence_privilege检查一个用户是否能以某种特定方式访问一个序列。它的参数可能性和has_table_privilege相似。所希望测试的访问权限类型必须是下列之一：USAGE、SELECT或UPDATE。

has_any_column_privilege检查一个用户是否能以特定方式访问一个表的任意列。其参数可能性和has_table_privilege类似，除了所希望的访问权限类型必须是下面值的某种组合：SELECT、INSERT、UPDATE或REFERENCES。注意在表层面上具有这些权限的任意一个都会隐式地把它授权给表中的每一列，因此如果has_table_privilege对同样的参数返回真则has_any_column_privilege将总是返回真。但是如果在至少一列上有一个该权限的列级授权，has_any_column_privilege也会成功。

has_column_privilege检查一个用户是否能以特定方式访问一个列。它的参数可能性与has_table_privilege类似，并且列还可以使用名字或者属性号来指定。希望的访问权限类型必须是下列值的某种组合：SELECT、INSERT、UPDATE或REFERENCES。注意在表级别上具有这些权限中的任意一种将会隐式地把它授予给表上的每一列。

has_database_privilege检查一个用户是否能以特定方式访问一个数据库。它的参数可能性类似 has_table_privilege。希望的访问权限类型必须是以下值的某种组合：CREATE、CONNECT、TEMPORARY或TEMP（等价于TEMPORARY）。

has_function_privilege检查一个用户是否能以特定方式访问一个函数。其参数可能性类似has_table_privilege。在用一个文本串而不是 OID 指定一个函数时，允许的输入和regprocedure数据类型一样（参阅 第 8.18 节）。希望的访问权限类型必须是EXECUTE。一个例子：

SELECT has_function_privilege('joeuser', 'myfunc(int, text)', 'execute');

has_foreign_data_wrapper_privilege检查一个用户是否能以特定方式访问一个外部数据包装器。它的参数可能性类似于has_table_privilege。希望的访问权限类型必须是USAGE。

has_language_privilege检查一个用户是否可以以某种特定的方式访问一个过程语言。 其参数可能性类似 has_table_privilege。希望的访问权限类型必须是USAGE。

has_schema_privilege检查一个用户是否可以以某种特定的方式访问一个模式。 其参数可能性类似 has_table_privilege。希望的访问权限类型必须是CREATE或USAGE。

has_server_privilege检查一个用户是否可以以某种特定的方式访问一个外部服务器。 其参数可能性类似 has_table_privilege。希望的访问权限类型必须是USAGE。

has_tablespace_privilege检查一个用户是否可以以某种特定的方式访问一个表空间。其参数可能性类似 has_table_privilege。希望的访问权限类型必须是CREATE。

pg_has_role检查一个用户是否可以以某种特定的方式访问一个角色。其参数可能性类似 has_table_privilege，除了public不能被允许作为一个用户名。希望的访问权限类型必须是下列值的某种组合：MEMBER或USAGE。MEMBER表示该角色中的直接或间接成员关系（即使用SET ROLE的权力），而USAGE表示不做SET ROLE的情况下该角色的权限是否立即可用。

row_security_active检查行级安全是否对 current_user以及环境上下文中的指定表是活跃的。 通过名称或者OID指定表。

row_security_active检查在current_user 的上下文和环境中是否为指定的表激活了行级安全性。表可以用名称或者 OID 指定。

表 9-61展示了决定是否一个特定对象在当前模式搜索路径中可见的函数。例如，如果一个表所在的模式在当前搜索路径中并且在它之前没有出现过相同的名字，这个表就被说是可见的。这等价于在语句中表可以被用名称引用但不加显式的模式限定。要列出所有可见表的名字：

SELECT relname FROM pg_class WHERE pg_table_is_visible(oid);

每一个函数对一种数据库对象执行可见性检查。 注意pg_table_is_visible也可被用于视图、索引和序列以及外表， pg_type_is_visible也可以被用于域。对于函数和操作符， 如果在路径中更早的地方没有出现具有相同名称和参数数据类型的对象， 该对象在搜索路径中是可见的。对于操作符类，名称和相关的索引访问方法都要考虑。

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

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

注意以这种方式测试一个非模式限定的类型名没什么意义 — 如果该名称完全能被识别，它必须是可见的。

表 9-62列出了从系统目录抽取信息的函数。

format_type返回一个数据类型的 SQL 名称，它由它的类型 OID 标识并且可能是一个类型修饰符。如果不知道相关的修饰符，则为类型修饰符传递 NULL。

pg_get_keywords返回一组记录描述服务器识别的 SQL 关键字。word列包含关键字。catcode列包含一个分类码：U为未被预定，C 为列名，T类型或函数名，R为预留。catdesc列包含一个可能本地化的描述分类的字符串。

pg_get_constraintdef、pg_get_indexdef、pg_get_ruledef和pg_get_triggerdef分别重建一个约束、索引、规则或触发器的创建命令（注意这是一个反编译的重构，而不是命令的原始文本）。pg_get_expr反编译一个表达式的内部形式，例如一个列的默认值。在检查系统目录内容时有用。如果表达式可能包含 Var，在第二个参数中指定它们引用的关系的 OID；如果不会出现 Var，第二个参数设置为 0 即可。pg_get_viewdef重构定义一个视图的SELECT查询。这些函数的大部分都有两种变体，一种可以可选地"优质打印"结果。优质打印的格式可读性更强，但是默认格式更可能被未来版本的PostgreSQL以相同的方式解释。在转出目的中避免使用优质打印输出。为优质打印参数传递假将得到和不带该参数的变体相同的结果。

pg_get_functiondef为一个函数返回一个完整的CREATE OR REPLACE FUNCTION语句。pg_get_function_arguments返回一个函数的参数列表，形式按照它们出现在CREATE FUNCTION中的那样。pg_get_function_result类似地返回函数的合适的RETURNS子句。pg_get_function_identity_arguments返回标识一个函数必要的参数列表，形式和它们出现在ALTER FUNCTION中的一样。这种形式忽略默认值。

pg_get_serial_sequence返回与一个列相关联的序列的名称，如果与列相关联的序列则返回 NULL。第一个输入参数是一个带可选模式的表名，第二个参数是一个列名。因为第一个参数可能是一个模式和表，它不能按照一个双引号包围的标识符来对待，意味着它默认情况下是小写的。而第二个参数只是一个列名，将被当作一个双引号包围的来处理并且会保留其大小写。函数返回的值会被适当地格式化以便传递给序列函数（参见第 9.16 节）。这种关联可以使用ALTER SEQUENCE OWNED BY来改变或移除（该函数应该曾经被称作pg_get_owned_sequence，它目前的名字反映了它通常和serial或bigserial列一起使用）。

pg_get_userbyid抽取给定 OID 的角色的名称。

pg_index_column_has_property、pg_index_has_property 和pg_indexam_has_property返回指定的索引列、 索引或者索引访问方法是否具有指定性质。如果性质的名称找不到或者不适用于特定的对象， 亦或者 OID 或者列号不表示合法的对象，则返回NULL。 列的性质可参见表 9-63， 索引的性质可参见表 9-64， 访问方法的性质可参见表 9-65 （注意扩展访问方法可以为其索引定义额外的性质）。

当传入pg_class.reloptions或pg_attribute.attoptions时，pg_options_to_table返回存储选项名称/值对（option_name/option_value）的集合。

pg_tablespace_databases允许一个表空间被检查。它返回一组数据库的 OID，这些数据库都有对象存储在该表空间中。如果这个函数返回任何行，则该表空间为非空并且不能被删除。为了显示该表空间中的指定对象，你将需要连接到pg_tablespace_databases标识的数据库并且查询它们的pg_class目录。

pg_typeof返回传递给它的值的数据类型的 OID。这在检修或者动态构建 SQL 查询时有用。函数被声明为返回regtype，它是一个 OID 别名类型（见第 8.18 节）；这表明它和一个用于比较目的的 OID 相同，但是作为一个类型名称显示。例如：

SELECT pg_typeof(33);

 pg_typeof 
-----------
 integer
(1 row) 

SELECT typlen FROM pg_type WHERE oid = pg_typeof(33);
 typlen 
--------
      4
(1 row)

表达式collation for返回传递给它的值的排序规则。例子：

SELECT collation for (description) FROM pg_description LIMIT 1;
 pg_collation_for 
------------------
 "default"
(1 row)

SELECT collation for ('foo' COLLATE "de_DE");
 pg_collation_for 
------------------
 "de_DE"
(1 row)

值可能被加上引号并且变成模式限定的。如果从参数表达式得不到排序规则，则返回一个空值。如果参数不是一个可排序的数据类型，则抛出一个错误。

to_regclass，to_regproc， to_regprocedure，to_regoper， to_regoperator，to_regtype， to_regnamespace以及to_regrole 函数各自转换关系，函数，操作符，类型，模式以及角色名称为 regclass，regproc，regprocedure， regoper，regoperator，regtype， regnamespace以及regrole类型对象。 这些函数不同于来自不接受数字OID的文本映射，并返回空而不是抛出一个错误。 如果没有找到名称（或to_regproc和to_regoper， 如果给定的名称匹配多个对象）。

表 9-66列出与数据库对象标识和寻址有关的函数。

pg_describe_object返回一个数据库对象的文本描述， 该数据库对象由目录 OID、对象 OID 和一个（可能为零）子对象 ID 指定。 这个描述会是人类可读的，并且可能是被翻译过的，具体情况取决于服务器配置。 这在判断存储在pg_depend目录中的一个对象的身份有用。

pg_identify_object返回一行， 其中包含足够的信息来唯一地标识数据库对象， 该数据库对象由目录 OID、对象 OID 和一个（可能为零）子对象 ID 指定。 这个信息是机器可读的，并且永远不会被翻译。type标识数据库对象的类型； schema是对象所属的模式的名称， 如果对象类型不属于模式则为NULL； name是对象的名称，必要时要加上引号， 只在能被用作对象的唯一标识符时出现（和模式名称一起，如果相关）， 否则为NULL；identity是完整的对象身份， 确切格式取决于对象类型，并且格式中的每一部分都是模式限定的并且按照需要被加上了引号。

pg_identify_object_as_address返回一行， 其中包含足够的信息来唯一地标识数据库对象， 该数据库对象由目录 OID、对象 OID 和一个（可能为零）子对象 ID 指定。 返回的信息是独立于当前服务器的，也就是说， 它可以用于标识另一个服务器中同一个命名对象。 type标识数据库对象的类型； name和args是形成对象引用的文本数组。 传递三列到pg_get_object_address获取对象的外部地址。 这个函数是pg_get_object_address的逆函数。

pg_get_object_address返回行， 包含足够信息来唯一地标识数据库对象，该数据库对象由类型和对象名称以及参数数组指定。 返回值是在系统目录中使用的比如pg_depend，并且可以传递给其它系统函数 比如pg_identify_object或者pg_describe_object。 catalog_id是包含对象的系统目录OID； object_id是对象本身的OID，object_sub_id是对象的子ID， 如果没有则为零。这个函数是pg_identify_object_as_address的逆函数。

表 9-67中展示的函数抽取注释，注释是由COMMENT命令在以前存储的。如果对指定参数找不到注释，则返回空值。

col_description为一个表列返回注释，该表列由所在表的 OID 和它的列号指定（obj_description不能被用在表列，因为表列没有自己的 OID）。

obj_description的双参数形式返回一个由其 OID 和所在系统目录名称指定的数据库对象的注释。例如，obj_description(123456,'pg_class')将会检索出 OID 为123456的表的注释。obj_description的单参数形式只要求对象 OID。它已经被废弃，因为无法保证 OID 在不同系统目录之间是唯一的；这样可能会返回错误的注释。

shobj_description用起来就像obj_description，但是前者是用于检索共享对象上的注释。某些系统目录对于一个集簇中的所有数据库是全局的，并且其中的对象的描述也是全局存储的。

表 9-68中展示的函数以一种可导出的形式提供了服务器事务信息。这些函数的主要用途是判断在两个快照之间哪些事务被提交。

内部事务 ID 类型（xid）是 32 位宽并且每 40 亿个事务就会回卷。但是，这些函数导出一种 64 位格式，它被使用一个"世代"计数器，这样在一个安装的生命期内不会回卷。这些函数使用的数据类型txid_snapshot存储了在一个特定时刻有关事务 ID 可见性的信息。它的成分在表 9-69中描述。

txid_snapshot的文本表示是xmin:xmax:xip_list。例如10:20:10,14,15表示xmin=10, xmax=20, xip_list=10, 14, 15。

在表 9-70中显示的函数 提供了已提交事务的信息。这些函数主要提供关于事务提交的信息。 当track_commit_timestamp配置选项启用的时候， 并且只有启用后提交的事务，它们只提供有用的数据。

表 9-70. 已提交事务信息

名称	返回类型	描述
pg_xact_commit_timestamp(xid)	timestamp with time zone	事务提交的时间戳
pg_last_committed_xact()	xid xid, timestamp timestamp with time zone	最近提交事务的事务ID以及提交时间戳

表 9-71中所展示的函数能打印initdb 期间初始化的信息，例如系统目录版本。 它们也能显示有关预写式日志和检查点处理的信息。这些信息是集簇范围内的， 不与任何特定的一个数据库相关。对于同一种来源，它们返回和 pg_controldata大致相同的信息，不过其形式更适合于 SQL函数。

表 9-71. Control Data Functions

名称	返回类型	描述
pg_control_checkpoint()	record	返回有关当前检查点状态的信息。
pg_control_system()	record	返回有关当前控制文件状态的信息。
pg_control_init()	record	返回有关集簇初始化状态的信息。
pg_control_recovery()	record	返回有关恢复状态的信息。

pg_control_checkpoint返回一个 表 9-72中所示的记录 。

表 9-72. pg_control_checkpoint 列

列名	数据类型
checkpoint_location	pg_lsn
prior_location	pg_lsn
redo_location	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

pg_control_system返回一个 表 9-73中所示的记录。

表 9-73. pg_control_system 列

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

pg_control_init返回一个 表 9-74中所示的记录。

表 9-74. 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
bigint_timestamps	boolean
float4_pass_by_value	boolean
float8_pass_by_value	boolean
data_page_checksum_version	integer

pg_control_recovery返回一个 表 9-75中所示的记录。

表 9-75. pg_control_recovery 列

列名	数据类型
min_recovery_end_location	pg_lsn
min_recovery_end_timeline	integer
backup_start_location	pg_lsn
backup_end_location	pg_lsn
end_of_backup_record_required	boolean