9.25. 系统信息函数

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

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

Table 9-51. 会话信息函数

名称返回类型描述
current_catalogname当前数据库名(SQL 标准中称作"目录"
current_database()name当前数据库名
current_query()text当前正在执行的查询的文本,和客户端提交的一样(可能包含多于一个语句)
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版本信息

Note: current_catalogcurrent_schemacurrent_usersession_useruserSQL里有特殊的语意状态: 它们被调用时结尾不要跟着园括号(在 PostgreSQL 中,圆括号可以有选择性地被用于current_schema,但是不能和其他的一起用)。

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

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

Note: 搜索路径可以在运行时修改。命令是:

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 域套接字进行的,那么所有这些函数都返回 NULL。

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

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

pg_conf_load_time返回最近一次服务器配置文件被载入的timestamp with time zone(如果当前会话在那时是活动的,这将是该会话重读配置文件的时间,因此读取的时间在不同会话中会变化。否则它将是 postmaster 进程重读配置文件的时间)。

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

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

Table 9-52. 访问权限查询函数

名称返回类型描述
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的变体,我们可以通过它们的参数数目和类型来区分它们) 。如果用名字指定,那么在必要时该名字可以是模式限定的。 所希望的权限类型是用一个文本串来指定的,它必须是下面的几个值之一: SELECTINSERTUPDATEDELETETRUNCATEREFERENCESTRIGGERWITH 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相似。所希望测试的访问权限类型必须是下列之一:USAGESELECTUPDATE

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

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

has_database_privilege检查一个用户是否能以特定方式访问一个数据库。它的参数可能性类似 has_table_privilege。希望的访问权限类型必须是以下值的某种组合:CREATECONNECTTEMPORARYTEMP(等价于TEMPORARY)。

has_function_privilege检查一个用户是否能以特定方式访问一个函数。其参数可能性类似has_table_privilege。在用一个文本串而不是 OID 指定一个函数时,允许的输入和regprocedure数据类型一样(参阅 Section 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不能被允许作为一个用户名。希望的访问权限类型必须是下列值的某种组合:MEMBERUSAGEMEMBER表示该角色中的直接或间接成员关系(即使用SET ROLE的权力),而USAGE表示不做SET ROLE的情况下该角色的权限是否立即可用。

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

SELECT relname FROM pg_class WHERE pg_table_is_visible(oid);

Table 9-53. 模式可见性查询函数

名称返回类型描述
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 别名类型(regclassregtyperegprocedureregoperatorregconfigregdictionary)将会很方便。例如:

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

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

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

Table 9-54. 系统目录信息函数

名称返回类型描述
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获得该参数的排序规则

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

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

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

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

当传入pg_class.reloptionspg_attribute.attoptions时,pg_options_to_table返回存储选项名称/值对(option_name/option_value)的集合。

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

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

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

pg_typeof返回传递给它的值的数据类型的 OID。这在检修或者动态构建 SQL 查询时有用。函数被声明为返回regtype,它是一个 OID 别名类型(见Section 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)

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

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

Table 9-55. 注释信息函数

名称返回类型描述
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 为123456的表的注释。obj_description的单参数形式只要求对象 OID。它已经被废弃,因为无法保证 OID 在不同系统目录之间是唯一的;这样可能会返回错误的注释。

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

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

Table 9-56. 事务 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 位格式,它被使用一个"世代"计数器,这样在一个安装的生命期内不会回卷。这些函数使用的数据类型txid_snapshot存储了在一个特定时刻有关事务 ID 可见性的信息。它的成分在Table 9-57中描述。

Table 9-57. 快照成分

名称描述
xmin 仍然活动的最早的事务 ID (txid)。所有更早的事务要么已经被提交并且可见,要么已经被回滚并且死亡。
xmax 第一个还未分配的 txid。所有大于等于它的 txid 在快照的时刻还没有开始,并且因此是不可见的。
xip_list 在快照时刻活动的 txid。这个列表只包括那些位于xminxmax之间的活动 txid;可能有活动的超过xmax的 txid。一个满足xmin <= txid < xmax并且不在这个列表中的 txid 在快照时刻已经结束,并且因此根据其提交状态要么可见要么死亡。该列表不包括子事务的 txid。

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