↑↓ 选择 ↵ 打开 ⌫ 改范围 完整检索页

pgsql.cc 提供对 postgresql.org 官网内容的中文翻译,由 Pigsty 团队维护。

受支持版本: 当前版本 (18) / 17 / 16 / 15 / 14
测试与开发版本: 19 / devel
不受支持的版本: 13 / 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0
历史版本PostgreSQL 8.2 已于 2011 年 12 月结束社区维护,本页译文保留供仍在使用旧版本的读者参考。新系统请看当前版本。

9.19. 系统信息函数 #

表 9.40列出了多个用于提取会话和系统信息的函数。

表 9.40. 会话信息函数

Name Return Type 描述
current_database() name 当前数据库名称
current_schema() name 当前模式名称
current_schemas(boolean) name[] 搜索路径中的模式名称,可选地包含隐式模式
current_user name 当前执行上下文的用户名
inet_client_addr() inet 远端连接地址
inet_client_port() int 远端连接端口
inet_server_addr() inet 本地连接地址
inet_server_port() int 本地连接端口
pg_my_temp_schema() oid 会话临时模式的 OID;不存在时为 0
pg_is_other_temp_schema(oid) boolean 该模式是否为另一个会话的临时模式?
pg_postmaster_start_time() timestamp with time zone 服务器启动时间
session_user name 会话用户名
user name 等价于 current_user
version() text PostgreSQL版本信息

session_user通常是发起当前数据库连接的用户;但超级用户可以用SET SESSION AUTHORIZATION更改这一设置。 current_user是适用于权限检查的用户标识符。通常它等于会话用户,但可以通过SET ROLE更改。在执行带有SECURITY DEFINER属性的函数期间,它也会改变。用 Unix 的话说,会话用户是“真实用户”,而当前用户是“有效用户”。

注意

current_user、session_user和user在SQL中具有特殊的语法地位:调用它们时不得带尾随的圆括号。

current_schema 返回搜索路径中第一个模式的名称(如果搜索路径为空,则返回空值)。在创建表或其他命名对象时,如果未指定目标模式,就会使用该模式。current_schemas(boolean) 返回当前搜索路径中所有模式名称的数组。布尔选项决定是否在返回的搜索路径中包含 pg_catalog 等隐式包含的系统模式。

注意

可以在运行时修改搜索路径,命令如下:

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

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值。

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

表 9.41列出了一些函数,它们允许用户通过编程方式查询对象访问权限。关于权限的更多信息,请参见第 5.6 节。

表 9.41. 访问权限查询函数

Name Return Type 描述
has_database_privilege(user, database, privilege) boolean 用户是否具有数据库权限
has_database_privilege(database, 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_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)指定;如果省略该参数,则假定使用current_user。表可以通过名称或 OID 指定。(因此,has_table_privilege实际上有六种变体,可以通过参数的数量和类型来区分。)通过名称指定时,如有需要,可以用模式限定名称。所需的访问权限类型由文本字符串指定,其值必须为SELECT、INSERT、UPDATE、DELETE、REFERENCES或TRIGGER之一。(不过字符串的大小写无关紧要。)一个例子是:

SELECT has_table_privilege('myschema.mytable', 'select');

has_database_privilege 检查用户是否可以以某种方式访问数据库。其参数形式与 has_table_privilege 类似。所需访问权限类型必须为 CREATE、CONNECT、TEMPORARY 或 TEMP(等同于 TEMPORARY)的某种组合。

has_function_privilege检查用户是否可以以某种方式访问函数。其参数形式类似于has_table_privilege。通过文本字符串而不是 OID 指定函数时,允许的输入与regprocedure数据类型相同(参见第 8.12 节)。所需访问权限类型必须为EXECUTE。例如:

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

has_language_privilege 检查用户是否可以以某种方式访问过程语言。其参数形式与 has_table_privilege 类似。所需访问权限类型必须为 USAGE。

has_schema_privilege 检查用户是否可以以某种方式访问模式。其参数形式与 has_table_privilege 类似。所需访问权限类型必须为 CREATE 或 USAGE 的某种组合。

has_tablespace_privilege 检查用户是否可以以某种方式访问表空间。其参数形式与 has_table_privilege 类似。所需访问权限类型必须为 CREATE。

pg_has_role检查用户是否可以以某种方式访问角色。它的参数可能性与has_table_privilege类似。所需访问权限类型必须为MEMBER或USAGE的某种组合。MEMBER表示直接或间接地属于该角色(即有权执行SET ROLE),而USAGE表示无需执行SET ROLE就能立即使用该角色的权限。

要测试用户是否持有某个权限的转授选项,可以在权限关键字后加上WITH GRANT OPTION;例如'UPDATE WITH GRANT OPTION'。

表 9.42列出了判断某个特定对象是否可见的函数,其判断依据是当前模式搜索路径。例如,如果表所在的模式位于搜索路径中,并且在搜索路径的更前面没有同名表,就称该表可见。这等价于说,可以只通过表名引用该表,而不必显式地用模式限定。要列出所有可见表的名称:

SELECT relname FROM pg_class WHERE pg_table_is_visible(oid);

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

Name Return Type 描述
pg_conversion_is_visible(conversion_oid) boolean 转换是否在搜索路径中可见
pg_function_is_visible(function_oid) boolean 函数是否在搜索路径中可见
pg_operator_is_visible(operator_oid) boolean 操作符是否在搜索路径中可见
pg_opclass_is_visible(opclass_oid) boolean 操作符类是否在搜索路径中可见
pg_table_is_visible(table_oid) boolean 表是否在搜索路径中可见
pg_type_is_visible(type_oid) boolean 类型(或域)是否在搜索路径中可见

pg_conversion_is_visible、pg_function_is_visible、pg_operator_is_visible、pg_opclass_is_visible、pg_table_is_visible和pg_type_is_visible分别对转换、函数、操作符、操作符类、表和类型执行可见性检查。注意,pg_table_is_visible也可用于视图、索引和序列;pg_type_is_visible也可用于域。对于函数和操作符,如果搜索路径中的一个对象在路径更早的位置没有同参数数据类型的同名对象,则该对象在搜索路径中可见。对于操作符和操作符类,要考虑名字和相关的索引访问方法。

所有这些函数都需要用对象 OID 标识要检查的对象。如果想按名称测试对象,使用 OID 别名类型会很方便(regclass、regtype、regprocedure或regoperator),例如:

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

注意,以这种方式测试一个不带模式限定的名称没有多大意义——如果该名称能够被识别,它必然是可见的。

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

表 9.43. 系统目录信息函数

Name Return Type 描述
format_type(type_oid, typemod) text 获取数据类型的 SQL 名称
pg_get_constraintdef(constraint_oid) text 获取约束定义
pg_get_constraintdef(constraint_oid, pretty_bool) text 获取约束定义
pg_get_expr(expr_text, relation_oid) text 反编译表达式的内部形式,假定其中所有 Var 节点都引用第二个参数指定的关系
pg_get_expr(expr_text, relation_oid, pretty_bool) text 反编译表达式的内部形式,假定其中所有 Var 节点都引用第二个参数指定的关系
pg_get_indexdef(index_oid) text 获取索引的 CREATE INDEX 命令
pg_get_indexdef(index_oid, column_no, pretty_bool) text 获取索引的CREATE INDEX命令,或在column_no不为零时仅获取一个索引列的定义
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 获取serial或bigserial列所使用的序列的名称
pg_get_triggerdef(trigger_oid) text 获取触发器的 CREATE [ CONSTRAINT ] TRIGGER 命令
pg_get_userbyid(roleid) name 获取具有给定 ID 的角色名称
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_tablespace_databases(tablespace_oid) setof oid 获取在该表空间中具有对象的数据库 OID 集合

format_type返回由类型 OID 和可能的类型修饰符标识的数据类型的 SQL 名称。如果没有具体的修饰符,则为类型修饰符传递 NULL。

pg_get_constraintdef、pg_get_indexdef、pg_get_ruledef和pg_get_triggerdef分别重建约束、索引、规则或触发器的创建命令。(注意,这是通过反编译重建的,并非命令的原始文本。)pg_get_expr反编译单个表达式的内部形式,例如列的默认值。这在检查系统目录内容时可能很有用。pg_get_viewdef重建定义视图的SELECT查询。这些函数中的大多数有两种变体,其中一种可以选择对结果进行“美化打印”。美化打印的格式更易读,但默认格式更有可能被未来版本的PostgreSQL以相同方式解释;做转储时应避免使用美化打印。向美化打印参数传入false,所得结果与没有该参数的变体完全相同。

pg_get_serial_sequence返回与某个列关联的序列的名称;如果该列没有关联的序列,则返回 NULL。第一个输入参数是可带模式的表名,第二个参数是列名。由于第一个参数可能是模式加表的形式,它不会按双引号标识符处理,也就是说默认会被转为小写;而第二个参数只是列名,会按双引号标识符处理,保留其大小写。该函数返回的值的格式适合传递给序列函数(见第 9.12 节)。这一关联可以用ALTER SEQUENCE OWNED BY修改或移除。(这个函数也许本应命名为pg_get_owned_sequence;它现在的名字反映了它通常与serial或bigserial列一起使用这一事实。)

pg_get_userbyid根据给定的 OID 获取角色的名称。

pg_tablespace_databases用于检查表空间。它返回在该表空间中存有对象的数据库的 OID 集合。如果这个函数返回了任何行,则该表空间非空,不能被删除。要显示占用该表空间的具体对象,你需要连接到pg_tablespace_databases标识出的各个数据库,并查询它们的pg_class目录。

表 9.44中的函数用于提取此前通过COMMENT命令存储的注释。如果找不到与指定参数对应的注释,则返回空值。

表 9.44. 注释信息函数

Name Return Type 描述
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 和列号指定。由于列本身没有各自的 OID,obj_description不能用于表列。

obj_description 的双参数形式返回数据库对象的注释,对象由其 OID 和所在系统目录的名称指定。例如,obj_description(123456,'pg_class') 会获取 OID 为 123456 的表的注释。obj_description 的单参数形式只需要对象 OID。该形式已被弃用,因为无法保证 OID 在不同系统目录之间唯一,因而可能返回错误的注释。

shobj_description的用法与obj_description相同,只是它用于获取共享对象的注释。有些系统目录由数据库集簇中的所有数据库全局共享,其中对象的描述也全局存储。

提交更正

译文有误、术语不当或页面显示问题,请到译文仓库 pgsty/pgdoc 报告译文问题。 英文原文本身的问题,请在当前版本的对应页面向上游反馈;上游不再修订已结束维护的版本。