9.25. 系统信息函数

表 9-56显示了几个抽取会话及系统信息的函数。

另外在本节所列出的函数,有一些函数有关统计系统,也提供系统信息。 参阅第 27.2.2 节获取更多信息。

表 9-56. 会话信息函数

NameReturn TypeDescription
current_catalogname当前数据库名(在SQL标准里叫"catalog"
current_database()name当前数据库名
current_query()text当前执行的查询文本,由客户端提交(可能包含多于1句)
current_schema[()]name当前模式名
current_schemas(boolean)name[]搜索路径中的模式名字,包括可选的隐式模式
current_username当前执行环境下的用户名
inet_client_addr()inet连接的远端地址
inet_client_port()int连接的远端端口
inet_server_addr()inet连接的本地地址
inet_server_port()int连接的本地端口
pg_backend_pid()int 连接到当前会话的服务器进程 ID
pg_conf_load_time()timestamp with time zone配置加载时间
pg_is_other_temp_schema(oid)boolean是否为另一个会话的临时模式?
pg_listening_channels()setof text正在侦听的当前会话的信道名称
pg_my_temp_schema()oid会话的临时模式的OID,不存在则为 0
pg_postmaster_start_time()timestamp with time zone服务器启动时间
pg_trigger_depth()intPostgreSQL 触发器的当前嵌套级别 (如果没有直接或间接的从一个触发器内部调用,那么是0)
session_username会话用户名
username等价于 current_user
version()textPostgreSQL 版本信息

注意: current_catalog, current_schema, current_user, session_user, 和userSQL里有特殊的语法: 调用他们时结尾不能跟圆括号。(在 PostgreSQL,current_schema 可选的可以有括号,但是其它的不能。)

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

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

注意: 搜索路径可以通过运行时设置更改。命令是:

SET search_path TO schema [, schema, ...]

pg_listening_channels返回当前会话正在监听的一组信道名称。 见LISTEN获取更多信息。

inet_client_addr返回当前客户端的IP地址, 而inet_client_port则返回当前客户端的端口号。 inet_server_addr返回服务器接收当前连接用的 IP 地址, 而inet_server_port返回接收当前连接的端口号。 如果是通过 Unix-domain socket 连接的,那么所有这些函数都返回 NULL 。

pg_my_temp_schema返回当前会话的临时模式 OID , 如果不存在的话则返回 0(因为没有创建任何临时表)。pg_is_other_temp_schema 返回给定的 OID 是否为其它会话的临时模式 OID ,这个函数是有实用价值的, 比如,在显示一个目录的时候排除掉其它会话的临时表。

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

pg_conf_load_time返回最后加载服务器配置文件的时间戳。 (如果当前会话在那时还活动,将是当前会话本身重新读取配置文件的时间, 所以读取的时间会在不同的会话中稍微有所不同。否则, 它是postmaster进程重新读取配置文件的时间。)

version返回一个描述PostgreSQL服务器版本信息的字符串。

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

表 9-57. 访问权限查询函数

名字返回类型描述
has_any_column_privilege(user, table, privilege) boolean指定用户是否有访问表任何列的权限
has_any_column_privilege(table, privilege) boolean当前用户是否有访问表任何列的权限
has_column_privilege(user, table, column, privilege) boolean指定用户是否有访问列的权限
has_column_privilege(table, column, privilege) boolean当前用户是否有访问列的权限
has_database_privilege(user, database, privilege) boolean指定用户是否有访问数据库的权限
has_database_privilege(database, privilege) boolean当前用户是否有访问数据库的权限
has_foreign_data_wrapper_privilege(user, fdw, privilege) boolean指定用户是否有访问外部数据封装器的权限
has_foreign_data_wrapper_privilege(fdw, privilege) boolean当前用户是否有访问外部数据封装器的权限
has_function_privilege(user, function, privilege) boolean指定用户是否有访问函数的权限
has_function_privilege(function, privilege) boolean当前用户是否有访问函数的权限
has_language_privilege(user, language, privilege) boolean指定用户是否有访问语言的权限
has_language_privilege(language, privilege) boolean当前用户是否有访问语言的权限
has_schema_privilege(user, schema, privilege) boolean指定用户是否有访问模式的权限
has_schema_privilege(schema, privilege) boolean当前用户是否有访问模式的权限
has_sequence_privilege(user, sequence, privilege) boolean指定用户是否有访问序列的权限
has_sequence_privilege(sequence, privilege) boolean当前用户是否有访问序列的权限
has_server_privilege(user, server, privilege) boolean指定用户是否有访问外部服务的权限
has_server_privilege(server, privilege) boolean当前用户是否有访问外部服务的权限
has_table_privilege(user, table, privilege) boolean指定用户是否有访问表的权限
has_table_privilege(table, privilege) boolean当前用户是否有访问表的权限
has_tablespace_privilege(user, tablespace, privilege) boolean指定用户是否有访问表空间的权限
has_tablespace_privilege(tablespace, privilege) boolean当前用户是否有访问表空间的权限
pg_has_role(user, role, privilege) boolean指定用户是否有角色的权限
pg_has_role(role, privilege) boolean当前用户是否有角色的权限

has_table_privilege检查用户是否可以用特定的方式访问表。 用户可以通过名字或OID(pg_authid.oid)来指定,public表明PUBLIC伪角色, 或如果缺省该参数,则使用current_user。该表可以通过名字或者 OID 声明。 因此,实际上有六种has_table_privilege变体, 我们可以通过它们的参数数目和类型来区分它们。如果用名字声明,那么在必要时可以用模式进行修饰。 所希望的权限类型是用一个文本字符串来声明的,必须是SELECT, INSERT, UPDATE, DELETE, TRUNCATE, REFERENCESTRIGGER之一。可选,可以添加WITH GRANT OPTION到权限类型, 以测试权限是否拥有授权选项。也可以用逗号分隔多个列出的权限类型,如果拥有任何所列出的权限, 则结果便为true。(权限字符串不区分大小写, 权限名之间允许有额外空白但不属于权限名的部分。)一些例子:

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

has_sequence_privilege检查用户是否可以用特定的方式访问序列。 参数可能与has_table_privilege类似。 想要的访问权限必须为USAGESELECTUPDATE之一。

has_any_column_privilege检查用户是否可以用特定的方式访问表的任何列。 其参数可能与has_table_privilege类似,除了想要的权限类型必须是SELECTINSERTUPDATE,或REFERENCES的一些组合。 请注意,在表级别拥有任何这些权限隐含授予它为每个表列,因此如果与 has_table_privilege 参数相同,has_any_column_privilege总是返回true。 但是如果有至少一列的列级权限授予也成功。

has_column_privilege检查用户是否可以用特定的方式访问一列。 其可能的参数类似于has_table_privilege, 可以通过列名或属性数添加列。想要的访问权限类型必须是SELECTINSERTUPDATE,或REFERENCES的一些组合。 请注意,在表级别拥有任何这些权限隐含授予它为每个表列。

has_database_privilege检查一个用户是否能以特定方式访问一个数据库。 它可能的参数类似has_table_privilege。权限类型必须是CREATECONNECTTEMPORARYTEMP (等价于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。权限类型必须是CREATEUSAGE的一些组合。

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

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

pg_has_role检查一个用户是否能以特定方式访问一个角色。 它可能的参数类似has_table_privilege,除了public 不能用做用户名。权限类型必须是MEMBERUSAGE的一些组合。 MEMBER表示的是角色中的直接或间接成员关系(也就是SET ROLE 的权限),而USAGE表示角色的权限是否无需SET ROLE即可立即生效。

表 9-58 显示了那些判断一个对象是否在当前模式搜索路径中可见的函数。 比如,如果一个表所在的模式在搜索路径中,并且没有同名的表出现在搜索路径的更靠前的地方, 那么就说这个表是可见的。它等效于表可以不带明确模式修饰进行引用。比如,要列出所有可见表的名字:

SELECT relname FROM pg_class WHERE pg_table_is_visible(oid);

表 9-58. 模式可见性查询函数

名字返回类型描述
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_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_table_is_visible 还可用于视图、索引、序列。pg_type_is_visible还可用于域。 对于函数和操作符,如果在搜索路径中没有名字相同并且参数的数据类型 也相同的对象出现在路径中更靠前的位置,那么该对象就是可见的。对于操作符类, 则要同时考虑名字和相关的索引访问方法。

所有这些函数都需要使用 OID 来标识要被检查的对象。如果你想通过名字测试对象, 那么使用 OID 别名类型(regclass, regtype, regprocedure, regoperator, regconfigregdictionary)将会很方便。例如:

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

请注意用这种方法测试一个未经修饰的名字没什么意义,因为如果一个名字可以被识别, 那它首先必须是可见的。

表 9-59列出了从系统表中抽取信息的函数。

表 9-59. 系统表信息函数

名字返回类型描述
format_type(type_oid, typemod)text获取一个数据类型的 SQL 名称
pg_describe_object(catalog_id, object_id, object_sub_id)text获取一个数据库对象的描述
pg_identify_object(catalog_id oid, object_id oid, object_sub_id integer)type text, schema text, name text, identity text获取一个数据库对象的身份
pg_get_constraintdef(constraint_oid)text获取一个约束的定义
pg_get_constraintdef(constraint_oid, pretty_bool)text获取一个约束的定义
pg_get_expr(pg_node_tree, relation_oid)text反编译一个表达式的内部形式,假设其中的任何 Var 都引用第二个参数指出的关系
pg_get_expr(pg_node_tree, relation_oid, pretty_bool)text反编译一个表达式的内部形式,假设其中的任何 Var 都引用第二个参数指出的关系
pg_get_functiondef(func_oid)text获取一个函数的定义
pg_get_function_arguments(func_oid)text获取函数定义的参数列表(带默认值)
pg_get_function_identity_arguments(func_oid)text获取参数列表来确定一个函数 (不带默认值)
pg_get_function_result(func_oid)text获取函数的RETURNS子句
pg_get_indexdef(index_oid)text获取索引的CREATE INDEX命令
pg_get_indexdef(index_oid, column_no, pretty_bool)text获取索引的CREATE INDEX命令,如果column_no不为零, 则只获取一个索引字段的定义。
pg_get_keywords()setof record获取SQL关键字和类别列表
pg_get_ruledef(rule_oid)text为规则获取CREATE RULE命令
pg_get_ruledef(rule_oid, pretty_bool)text为规则获取CREATE RULE命令
pg_get_serial_sequence(table_name, column_name)text获取一个serialsmallserialbigserial字段使用的序列名
pg_get_triggerdef(trigger_oid)text为触发器获取CREATE [ CONSTRAINT ] TRIGGER命令
pg_get_triggerdef(trigger_oid, pretty_bool)text为触发器获取CREATE [ CONSTRAINT ] TRIGGER命令
pg_get_userbyid(role_oid)name获取给定 OID 的角色名
pg_get_viewdef(view_name)text为视图或物化视图获取底层的SELECT命令(已废弃)
pg_get_viewdef(view_name, pretty_bool)text为视图或物化视图获取底层的SELECT命令(已废弃)
pg_get_viewdef(view_oid)text为视图或物化视图获取底层的SELECT命令
pg_get_viewdef(view_oid, pretty_bool)text为视图或物化视图获取底层的SELECT命令
pg_get_viewdef(view_oid, wrap_column_int)text为视图或物化视图获取底层的SELECT命令;行字段被换到指定的列数,打印是隐含的
pg_options_to_table(reloptions)setof record获取存储选项名称/值对的集合
pg_tablespace_databases(tablespace_oid)setof oid获取在指定的表空间有元素的数据库 OID 集合
pg_tablespace_location(tablespace_oid)text获取表空间所在的文件系统的路径
pg_typeof(any)regtype获取任何值的数据类型
collation for (any)text获取参数的排序
to_regclass(rel_name)regclass获取命名关系的OID
to_regproc(func_name)regproc获取命名函数的OID
to_regprocedure(func_name)regprocedure获取命名函数的OID
to_regoper(operator_name)regoper获取命名操作符的OID
to_regoperator(operator_name)regoperator获取命名操作符的OID
to_regtype(type_name)regtype获取命名类型的OID

format_type通过某个数据类型的类型 OID 以及可能的类型修饰词返回其 SQL 名称。 如果不知道具体的修饰词,那么在类型修饰词的位置传入 NULL 。

pg_get_keywords返回一组记录描述服务器识别的 SQL 关键字。 word列包含关键字。catcode列包含一个分类代码: U通用的,C列名,T类型或函数名,或R保留。 catdesc列包含了一个可能本地化描述分类的字符串。

pg_get_constraintdefpg_get_indexdefpg_get_ruledef,和pg_get_triggerdef 分别从一个约束、索引、规则或触发器上重新构造创建它们的命令(反编译的重新构造, 而不是该命令的原文)。pg_get_expr反编译一个独立表达式的内部形式, 比如一个字段的缺省值。在检查系统表的内容的时候很有用。如果表达式可能包含Var, 那么指定他们参考的关联的OID为第二个参数;如果没有Var,0就足够了。 pg_get_viewdef重新构造出定义视图的SELECT查询。 这些函数大多数都有两个变种,其中一个是"适合打印"的结果。这种格式更容易读, 但是缺省的格式更有可能被将来的PostgreSQL版本用同样的方法解释; 如果是用于转储,那么尽可能避免使用适合打印的格式。给 pretty-print参数传递false 生成的结果和没有这个参数的变种生成的结果是完全一样。

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或许更为妥当, 因为它的当前名字反映了它通常用于serialbigserial字段的事实。)

pg_get_userbyid通过角色的 OID 抽取对应的用户名。

pg_options_to_table当通过pg_class.reloptionspg_attribute.attoptions时返回存储选项名字/值对 (option_name/option_value)的集合。

pg_tablespace_databases允许检查一个表空间的状况, 它返回在该表空间中保存了对象的数据库 OID 集合。如果这个函数返回数据行, 那么该表空间就是非空的,因此不能删除。要显示该表空间中的特定对象, 你需要把pg_tablespace_databases 返回的数据库标识与 pg_class表连接进行查询。

pg_describe_object返回由目录OID,对象OID和一个(或许0个) 子对象ID指定的数据库对象的描述。这个描述趋向于人类易读,并且可能是经过翻译的,取决于服务器的配置。 这有助于确定一个对象的标识存储在pg_depend目录中。

pg_identify_object返回一个包含足够信息来唯一的标识由系统OID, 对象OID和一个(或许0个)子对象ID指定的数据库对象的行。这个信息趋向于机器易读,并且从不翻译。 type标识数据库对象的类型;schema是对象属于的模式名,或 NULL 表明对象类型不属于模式;name 是对象的名字,如果需要就加上双引号, 只有在它可以用作对象的唯一标识符时使用(如果相关,跟随模式名),否则为NULLidentity是完整的对象身份,根据对象类型有精确的格式,并且格式内的每个部分都是模式限定的, 必要时加双引号。

pg_typeof返回传递给它的值的数据类型OID。 这可能有利于故障排除或动态构造SQL查询。函数声明返回OID别名类型的regtype (参阅第 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)

值可能是引号括起来的并且模式限制的。如果没有为参数表达式排序,那么返回一个null值。 如果参数不是排序的类型,那么抛出一个错误。

to_regclassto_regprocto_regprocedureto_regoperto_regoperatorto_regtype 函数分别转换关系、函数、操作符和类型名到类型为regclassregprocregprocedureregoperregoperatorregtype的对象。 这些函数与文本转换的区别在于它们不接受数字OID, 并且如果没有找到名字,它们返回空而不是抛出一个错误 (或者,对于to_regprocto_regoper, 是如果给出的名字匹配多个对象)。

表 9-60显示的函数将原来用COMMENT 命令存储的评注抽取出来。如果没有找到,则返回 NULL 。

表 9-60. 注释信息函数

名字返回类型描述
col_description(table_oid, column_number)text获取一个表字段的评注
obj_description(object_oid, catalog_name)text获取一个数据库对象的评注
obj_description(object_oid)text获取一个数据库对象的评注(已废弃)
shobj_description(object_oid, catalog_name)text获取一个共享数据库对象的评注

col_description返回一个表中字段的评注,它是通过表 OID 和字段号来声明的。 obj_description不能用于表字段,因为字段没有自己的 OID 。

带有两个参数的obj_description返回一个数据库对象的评注, 该对象是通过其 OID 和其所属的系统表名字声明的。比如,obj_description(123456,'pg_class') 将返回 OID 为 12345 的表的评注。只带一个参数的obj_description 只要求对象 OID ,现在已经废弃了,因为我们不再保证 OID 在不同的系统表之间是唯一的, 因此可能会返回错误的评注。

shobj_descriptionobj_description差不多, 不同之处仅在于前者用于共享对象。一些系统表是通用于集群中所有数据库的全局表, 因此这些表的评注也是全局存储的。

表 9-61显示的函数在一个输出形式中提供服务器事务信息。 这些函数的主要用途是为了确定在两个快照之间有哪个事务提交。

表 9-61. 事务ID和快照

名字返回类型描述
txid_current()bigint获取当前事务 ID
txid_current_snapshot()txid_snapshot获取当前快照
txid_snapshot_xip(txid_snapshot)setof bigint获取在快照中进行中的事务ID
txid_snapshot_xmax(txid_snapshot)bigint获取快照的 xmax
txid_snapshot_xmin(txid_snapshot)bigint获取快照的xmin
txid_visible_in_snapshot(bigint, txid_snapshot)boolean在快照中事务ID是否可见?(不使用子事务ID)

内部事务 ID 类型(xid)是32位,每40亿事务循环。然而这些函数导出一个64位格式, 是使用一个"epoch"计数器扩展,所以在安装过程中不会循环。 这些函数使用的数据类型txid_snapshot,存储在某时刻事物ID可见性的信息。 其组件描述在表 9-62

表 9-62. 快照组件

名字描述
xmin 最早的事务ID(txid)仍然活动。所有较早事务将是可见提交了,或者要么死掉回滚了。
xmax 首先作为尚未分配的txid。所有大于或等于此的txids作为这时的快照都是尚未开始的,因此不可见。
xip_list 在当前快照活动的txids。这个列表只包含在xminxmax 之间的活动txids;有可能活动的txids高于xmax。 一个xmin <= txid < xmax,并且不在这个列表中的txid, 是在快照的这个时间已经完成的,因此要么可见或死掉对应它的提交状态。 这个列表不包含子事务的txids。

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