系统信息函数

会话信息函数

  • current_catalog

    描述：当前数据库的名称（在标准SQL中称”catalog”）。

    返回值类型：name

    示例：

    1. postgres=# SELECT current_catalog;
    2.  current_database
    3. ------------------
    4.  postgres
    5. (1 row)

  • current_database()

    描述：当前数据库的名称。

    返回值类型：name

    示例：

    1. postgres=# SELECT current_database();
    2.  current_database
    3. ------------------
    4.  postgres
    5. (1 row)

  • current_query()

    描述：由客户端提交的当前执行语句（可能包含多个声明）。

    返回值类型：text

    示例：

    1. postgres=# SELECT current_query();
    2.       current_query
    3. -------------------------
    4.  SELECT current_query();
    5. (1 row)

  • current_schema[()]

    描述：当前模式的名称。

    返回值类型：name

    示例：

    1. postgres=# SELECT current_schema();
    2.  current_schema
    3. ----------------
    4.  public
    5. (1 row)

    备注：current_schema返回在搜索路径中第一个顺位有效的模式名。（如果搜索路径为空则返回NULL，没有有效的模式名也返回NULL）。如果创建表或者其他命名对象时没有声明目标模式，则将使用这些对象的模式。

  • current_schemas(Boolean)

    描述：搜索路径中的模式名称。

    返回值类型：name[]

    示例：

    1. postgres=# SELECT current_schemas(true);
    2.    current_schemas
    3. ---------------------
    4.  {pg_catalog,public}
    5. (1 row)

    备注：

    current_schemas(Boolean)返回搜索路径中所有模式名称的数组。布尔选项决定像pg_catalog这样隐含包含的系统模式是否包含在返回的搜索路径中。

    系统信息函数 - 图1 说明：
    搜索路径可以通过运行时设置更改。命令是：

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

  • current_user

    描述：当前执行环境下的用户名。

    返回值类型：name

    示例：

    1. postgres=# SELECT current_user;
    2.  current_user
    3. --------------
    4.  omm
    5. (1 row)

    备注：current_user是用于权限检查的用户标识。通常，他表示会话用户，但是可以通过SET ROLE改变他。在函数执行的过程中随着属性SECURITY DEFINER的改变，其值也会改变。

  • pg_current_sessionid()

    描述：当前执行环境下的会话ID。

    返回值类型：text

    示例：

    1. postgres=# SELECT pg_current_sessionid();
    2.     pg_current_sessionid
    3. ----------------------------
    4.  1579228402.140190434944768
    5. (1 row)

    备注：pg_current_sessionid()是用于获取当前执行环境下的会话ID。其组成结构为：时间戳.会话ID，当线程池模式开启（enable_thread_pool=on）时，会话ID为SessionID；而线程池模式关闭时，会话ID为ThreadID。

  • inet_client_addr()

    描述：连接的远端地址。inet_client_addr返回当前客户端的IP地址。

    系统信息函数 - 图2 说明：
    此函数只有在远程连接模式下有效。

    返回值类型：inet

    示例：

    1. postgres=# SELECT inet_client_addr();
    2.  inet_client_addr
    3. ------------------
    4.  10.10.0.50
    5. (1 row)

  • inet_client_port()

    描述：连接的远端端口。inet_client_port返回当前客户端的端口号。

    系统信息函数 - 图3 说明：
    此函数只有在远程连接模式下有效。

    返回值类型：int

    示例：

    1. postgres=# SELECT inet_client_port();
    2.  inet_client_port
    3. ------------------
    4.             33143
    5. (1 row)

  • inet_server_addr()

    描述：连接的本地地址。inet_server_addr返回服务器接收当前连接用的IP地址。

    系统信息函数 - 图4 说明：
    此函数只有在远程连接模式下有效。

    返回值类型：inet

    示例：

    1. postgres=# SELECT inet_server_addr();
    2.  inet_server_addr
    3. ------------------
    4.  10.10.0.13
    5. (1 row)

  • inet_server_port()

    描述：连接的本地端口。inet_server_port返回接收当前连接的端口号。如果是通过Unix-domain socket连接的，则所有这些函数都返回NULL。

    系统信息函数 - 图5 说明：
    此函数只有在远程连接模式下有效。

    返回值类型：int

    示例：

    1. postgres=# SELECT inet_server_port();
    2.  inet_server_port
    3. ------------------
    4.              8000
    5. (1 row)

  • pg_backend_pid()

    描述：当前会话连接的服务进程的进程ID。

    返回值类型：int

    示例：

    1. postgres=# SELECT pg_backend_pid();
    2.  pg_backend_pid
    3. -----------------
    4.  140229352617744
    5. (1 row)

  • pg_conf_load_time()

    描述：配置加载时间。pg_conf_load_time返回最后加载服务器配置文件的时间戳。

    返回值类型：timestamp with time zone

    示例：

    1. postgres=# SELECT pg_conf_load_time();
    2.       pg_conf_load_time       
    3. ------------------------------
    4.  2017-09-01 16:05:23.89868+08
    5. (1 row)

  • pg_my_temp_schema()

    描述：会话的临时模式的OID，不存在则为0。

    返回值类型：oid

    示例：

    1. postgres=# SELECT pg_my_temp_schema();
    2.  pg_my_temp_schema 
    3. -------------------
    4.                  0
    5. (1 row)

    备注：pg_my_temp_schema返回当前会话中临时模式的OID，如果不存在（没有创建临时表）的话则返回0。如果给定的OID是其它会话中临时模式的OID，pg_is_other_temp_schema则返回true。

  • pg_is_other_temp_schema(oid)

    描述：是否为另一个会话的临时模式。

    返回值类型：Boolean

    示例：

    1. postgres=# SELECT pg_is_other_temp_schema(25356);
    2.  pg_is_other_temp_schema
    3. -------------------------
    4.  f
    5. (1 row)

  • pg_listening_channels()

    描述：会话正在监听的信道名称。

    返回值类型：setof text

    示例：

    1. postgres=# SELECT pg_listening_channels();
    2.  pg_listening_channels
    3. -----------------------
    4. (0 rows)

    备注：pg_listening_channels返回当前会话正在监听的一组信道名称。

  • pg_postmaster_start_time()

    描述：服务器启动时间。pg_postmaster_start_time返回服务器启动时的timestamp with time zone。

    返回值类型：timestamp with time zone

    示例：

    1. postgres=# SELECT pg_postmaster_start_time();
    2.    pg_postmaster_start_time   
    3. ------------------------------
    4.  2017-08-30 16:02:54.99854+08
    5. (1 row)

  • pg_trigger_depth()

    描述：触发器的嵌套层次。

    返回值类型：int

    示例：

    1. postgres=# SELECT pg_trigger_depth();
    2.  pg_trigger_depth 
    3. ------------------
    4.                 0
    5. (1 row)

  • pgxc_version()

    描述：Postgres-XC版本信息。

    返回值类型：text

    示例：

    1. postgres=# SELECT pgxc_version();
    2.                                                 pgxc_version                                                 
    3. -------------------------------------------------------------------------------------------------------------
    4.  Postgres-XC 1.1 on x86_64-unknown-linux-gnu, based on PostgreSQL 9.2.4, compiled by g++ (GCC) 5.4.0, 64-bit
    5. (1 row)

  • session_user

    描述：会话用户名。

    返回值类型：name

    示例：

    1. postgres=# SELECT session_user;
    2.  session_user
    3. --------------
    4.  omm
    5. (1 row)

    备注：session_user通常是连接当前数据库的初始用户，不过系统管理员可以用SET SESSION AUTHORIZATION修改这个设置。

  • user

    描述：等价于current_user。

    返回值类型：name

    示例：

    1. postgres=# SELECT user;
    2.  current_user
    3. --------------
    4.  omm
    5. (1 row)

  • version()

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

    返回值类型：text

    示例：

    1. postgres=# SELECT version();
    2.                                                                 version                                                                
    3. ---------------------------------------------------------------------------------------------------------------------------------------
    4.  PostgreSQL 9.2.4 (openGauss-1.0.0 build 66e54e4d) compiled at 2020-01-02 13:02:26 commit 7218 last mr 10175  on x86_64-unknown-linux-gnu, compiled by g++ (GCC) 8.2.0, 64-bit
    6. (1 row)

访问权限查询函数

  • has_any_column_privilege(user, table, privilege)

    描述：指定用户是否有访问表任何列的权限。

    返回类型：Boolean

  • has_any_column_privilege(table, privilege)

    描述：当前用户是否有访问表任何列的权限。

    返回类型：Boolean

    备注：has_any_column_privilege检查用户是否以特定方式访问表的任何列。其参数可能与has_table_privilege类似，除了访问权限类型必须是SELECT、INSERT、UPDATE或REFERENCES的一些组合。

    系统信息函数 - 图6 说明：
    拥有表的表级别权限则隐含的拥有该表每列的列级权限，因此如果与has_table_privilege参数相同，has_any_column_privilege总是返回true。但是如果授予至少一列的列级权限也返回成功。

  • has_column_privilege(user, table, column, privilege)

    描述：指定用户是否有访问列的权限。

    返回类型：Boolean

  • has_column_privilege(table, column, privilege)

    描述：当前用户是否有访问列的权限。

    返回类型：Boolean

    备注：has_column_privilege检查用户是否以特定方式访问一列。其参数类似于has_table_privilege，可以通过列名或属性号添加列。想要的访问权限类型必须是SELECT、INSERT、UPDATE或REFERENCES的一些组合。

    系统信息函数 - 图7 说明：
    拥有表的表级别权限则隐含的拥有该表每列的列级权限。

  • has_database_privilege(user, database, privilege)

    描述：指定用户是否有访问数据库的权限。

    返回类型：Boolean

  • has_database_privilege(database, privilege)

    描述：当前用户是否有访问数据库的权限。

    返回类型：Boolean

    备注：has_database_privilege检查用户是否能以在特定方式访问数据库。其参数类似has_table_privilege。访问权限类型必须是CREATE、CONNECT、TEMPORARY或TEMP（等价于TEMPORARY）的一些组合。

  • has_directory_privilege(user, database, privilege)

    描述：指定用户是否有访问directory的权限。

    返回类型：Boolean

  • has_directory_privilege(database, privilege)

    描述：当前用户是否有访问directory的权限。

    返回类型：Boolean

  • has_foreign_data_wrapper_privilege(user, fdw, privilege)

    描述：指定用户是否有访问外部数据封装器的权限。

    返回类型：Boolean

  • has_foreign_data_wrapper_privilege(fdw, privilege)

    描述：当前用户是否有访问外部数据封装器的权限。

    返回类型：Boolean

    备注：has_foreign_data_wrapper_privilege检查用户是否能以特定方式访问外部数据封装器。其参数类似has_table_privilege。访问权限类型必须是USAGE。

  • has_function_privilege(user, function, privilege)

    描述：指定用户是否有访问函数的权限。

    返回类型：Boolean

  • has_function_privilege(function, privilege)

    描述：当前用户是否有访问函数的权限。

    返回类型：Boolean

    备注：has_function_privilege检查一个用户是否能以指定方式访问一个函数。其参数类似has_table_privilege。使用文本字符而不是OID声明一个函数时，允许输入的类型和regprocedure数据类型一样（请参考对象标识符类型）。访问权限类型必须是EXECUTE。

  • has_language_privilege(user, language, privilege)

    描述：指定用户是否有访问语言的权限。

    返回类型：Boolean

  • has_language_privilege(language, privilege)

    描述：当前用户是否有访问语言的权限。

    返回类型：Boolean

    备注：has_language_privilege检查用户是否能以特定方式访问一个过程语言。其参数类似has_table_privilege。访问权限类型必须是USAGE。

  • has_schema_privilege(user, schema, privilege)

    描述：指定用户是否有访问模式的权限。

    返回类型：Boolean

  • has_schema_privilege(schema, privilege)

    描述：当前用户是否有访问模式的权限。

    返回类型：Boolean

    备注：has_schema_privilege检查用户是否能以特定方式访问一个模式。其参数类似has_table_privilege。访问权限类型必须是CREATE或USAGE的一些组合。

  • has_server_privilege(user, server, privilege)

    描述：指定用户是否有访问外部服务的权限。

    返回类型：Boolean

  • has_server_privilege(server, privilege)

    描述：当前用户是否有访问外部服务的权限。

    返回类型：Boolean

    备注：has_server_privilege检查用户是否能以指定方式访问一个外部服务器。其参数类似has_table_privilege。访问权限类型必须是USAGE。

  • has_table_privilege(user, table, privilege)

    描述：指定用户是否有访问表的权限。

    返回类型：Boolean

  • has_table_privilege(table, privilege)

    描述：当前用户是否有访问表的权限。

    返回类型：Boolean

    备注：has_table_privilege检查用户是否以特定方式访问表。用户可以通过名称或OID（pg_authid.oid）来指定，public表明PUBLIC伪角色，或如果缺省该参数，则使用current_user。该表可以通过名称或者OID声明。如果用名称声明，则在必要时可以用模式进行修饰。如果使用文本字符串来声明所希望的权限类型，这个文本字符串必须是SELECT、INSERT、UPDATE、DELETE、TRUNCATE、REFERENCES或TRIGGER之一的值。可以给权限类型添加WITH GRANT OPTION，用来测试权限是否拥有授权选项。也可以用逗号分隔列出的多个权限类型，如果拥有任何所列出的权限，则结果便为true。

    示例：

    1. postgres=# SELECT has_table_privilege('tpcds.web_site', 'select');
    2.  has_table_privilege  
    3. --------------------- 
    4.  t 
    5. (1 row)
    7. postgres=# SELECT has_table_privilege('omm', 'tpcds.web_site', 'select,INSERT WITH GRANT OPTION ');
    8.  has_table_privilege  
    9. --------------------- 
    10.  t 
    11. (1 row)

  • has_tablespace_privilege(user, tablespace, privilege)

    描述：指定用户是否有访问表空间的权限。

    返回类型：Boolean

  • has_tablespace_privilege(tablespace, privilege)

    描述：当前用户是否有访问表空间的权限。

    返回类型：Boolean

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

  • pg_has_role(user, role, privilege)

    描述：指定用户是否有角色的权限。

    返回类型：Boolean

  • pg_has_role(role, privilege)

    描述：当前用户是否有角色的权限。

    返回类型：Boolean

    备注：pg_has_role检查用户是否能以特定方式访问一个角色。其参数类似has_table_privilege，除了public不能用做用户名。访问权限类型必须是MEMBER或USAGE的一些组合。 MEMBER表示的是角色中的直接或间接成员关系（也就是SET ROLE的权限），而USAGE表示无需通过SET ROLE也直接拥有角色的使用权限。

模式可见性查询函数

每个函数执行检查数据库对象类型的可见性。对于函数和操作符，如果在前面的搜索路径中没有相同的对象名称和参数的数据类型，则此对象是可见的。对于操作符类，则要同时考虑名称和相关索引的访问方法。

所有这些函数都需要使用OID来标识要需要检查的对象。如果用户想通过名称测试对象，则使用OID别名类型（regclass、regtype、regprocedure、regoperator、regconfig或regdictionary）将会很方便。

比如，如果一个表所在的模式在搜索路径中，并且在前面的搜索路径中没有同名的表，则这个表是可见的。它等效于表可以不带明确模式修饰进行引用。比如，要列出所有可见表的名称：

  1. postgres=# SELECT relname FROM pg_class WHERE pg_table_is_visible(oid);

  • 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

系统表信息函数

  • format_type(type_oid, typemod)

    描述：获取数据类型的SQL名称

    返回类型：text

    备注：format_type通过某个数据类型的类型OID以及可能的类型修饰词，返回其SQL名称。如果不知道具体的修饰词，则在类型修饰词的位置传入NULL。类型修饰词一般只对有长度限制的数据类型有意义。format_type所返回的SQL名称中包含数据类型的长度值，其大小是：实际存储长度len - sizeof(int32)，单位字节。原因是数据存储时需要32位的空间来存储用户对数据类型的自定义长度信息，即实际存储长度要比用户定义长度多4个字节。在下例中，format_type返回的SQL名称为“character varying(6)”，6表示varchar类型的长度值是6字节，因此该类型的实际存储长度为10字节。

    1. postgres=# SELECT format_type((SELECT oid FROM pg_type WHERE typname='varchar'), 10);
    2.      format_type      
    3. ----------------------
    4.  character varying(6)
    5. (1 row)

  • pg_check_authid(role_oid)

    描述：检查是否存在给定oid的角色名

    返回类型：bool

  • pg_describe_object(catalog_id, object_id, object_sub_id)

    描述：获取数据库对象的描述

    返回类型：text

    备注：pg_describe_object返回由目录OID，对象OID和一个（或许0个）子对象ID指定的数据库对象的描述。这有助于确认存储在pg_depend系统表中对象的身份。

  • pg_get_constraintdef(constraint_oid)

    描述：获取约束的定义

    返回类型：text

  • pg_get_constraintdef(constraint_oid, pretty_bool)

    描述：获取约束的定义

    返回类型：text

    备注：pg_get_constraintdef和pg_get_indexdef分别从约束或索引上使用创建命令进行重构。

  • pg_get_expr(pg_node_tree, relation_oid)

    描述：反编译表达式的内部形式，假设其中的任何Vars都引用第二个参数指定的关系。

    返回类型：text

  • pg_get_expr(pg_node_tree, relation_oid, pretty_bool)

    描述：反编译表达式的内部形式，假设其中的任何Vars都引用第二个参数指定的关系。

    返回类型：text

    备注：pg_get_expr反编译一个独立表达式的内部形式，比如一个字段的缺省值。在检查系统表的内容的时候很有用。如果表达式可能包含关键字，则指定他们引用相关的OID作为第二个参数；如果没有关键字，零就足够了。

  • pg_get_functiondef(func_oid)

    描述：获取函数的定义

    返回类型：text

  • pg_get_function_arguments(func_oid)

    描述：获取函数定义的参数列表（带默认值）

    返回类型：text

    备注：pg_get_function_arguments返回一个函数的参数列表，需要在CREATE FUNCTION中使用这种格式。

  • pg_get_function_identity_arguments(func_oid)

    描述：获取参数列表来确定一个函数 (不带默认值)

    返回类型：text

    备注：pg_get_function_identity_arguments返回需要的参数列表用来标识函数，这种形式需要在ALTER FUNCTION中使用，并且这种形式省略了默认值。

  • pg_get_function_result(func_oid)

    描述：获取函数的RETURNS子句

    返回类型：text

    备注：pg_get_function_result为函数返回适当的RETURNS子句。

  • pg_get_indexdef(index_oid)

    描述：获取索引的CREATE INDEX命令

    返回类型：text

  • pg_get_indexdef(index_oid, column_no, pretty_bool)

    描述：获取索引的CREATE INDEX命令，或者如果column_no不为零，则只获取一个索引字段的定义。

    返回类型：text

    备注：pg_get_functiondef为函数返回一个完整的CREATE OR REPLACE FUNCTION语句。

  • pg_get_keywords()

    描述：获取SQL关键字和类别列表

    返回类型：setof record

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

  • pg_get_userbyid(role_oid)

    描述：获取给定OID的角色名

    返回类型：name

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

  • pg_get_viewdef(view_name)

    描述：为视图获取底层的SELECT命令

    返回类型：text

  • pg_get_viewdef(view_name, pretty_bool)

    描述：为视图获取底层的SELECT命令，如果pretty_bool为true，行字段可以包含80列。

    返回类型：text

    备注：pg_get_viewdef重构出定义视图的SELECT查询。这些函数大多数都有两种形式，其中带有pretty_bool参数，且参数为true时，是”适合打印”的结果，这种格式更容易读。另一种是缺省的格式，更有可能被将来的不同版本用同样的方法解释。如果是用于转储，那么尽可能避免使用适合打印的格式。给pretty-print参数传递false生成的结果和没有这个参数的变种生成的结果是完全一样。

  • pg_get_viewdef(view_oid)

    描述：为视图获取底层的SELECT命令

    返回类型：text

  • pg_get_viewdef(view_oid, pretty_bool)

    描述：为视图获取底层的SELECT命令，如果pretty_bool为true，行字段可以包含80列。

    返回类型：text

  • pg_get_viewdef(view_oid, wrap_column_int)

    描述：为视图获取底层的SELECT命令；行字段被换到指定的列数，打印是隐含的。

    返回类型：text

  • pg_get_tabledef(table_oid)

    描述：根据table_oid获取表定义

    返回类型：text

  • pg_get_tabledef(table_name)

    描述：根据table_name获取表定义

    返回类型：text

    备注：pg_get_tabledef重构出表定义的CREATE语句，包含了表定义本身、索引信息、comments信息。对于表对象依赖的group、schema、tablespace、server等信息，需要用户自己去创建，表定义里不会有这些对象的创建语句。

  • pg_options_to_table(reloptions)

    描述：获取存储选项名称/值对的集合

    返回类型：setof record

    备注：pg_options_to_table当通过pg_class.reloptions或pg_attribute.attoptions时返回存储选项名称/值对（option_name/option_value）的集合。

  • pg_tablespace_databases(tablespace_oid)

    描述：获取在指定的表空间中有对象的数据库OID集合

    返回类型：setof oid

    备注：pg_tablespace_databases允许检查表空间的状况，返回在该表空间中保存了对象的数据库OID集合。如果这个函数返回数据行，则该表空间就是非空的，因此不能删除。要显示该表空间中的特定对象，用户需要连接pg_tablespace_databases标识的数据库与查询pg_class系统表。

  • pg_tablespace_location(tablespace_oid)

    描述：获取表空间所在的文件系统的路径

    返回类型：text

  • pg_typeof(any)

    描述：获取任何值的数据类型

    返回类型：regtype

    备注：pg_typeof返回传递给他的值的数据类型OID。这可能有助于故障排除或动态构造SQL查询。声明此函数返回regtype，这是一个OID别名类型（请参考对象标识符类型）；这意味着它是一个为了比较而显示类型名称的OID。

    示例：

    1. postgres=# SELECT pg_typeof(33);
    2.  pg_typeof 
    3. -----------
    4.  integer
    5. (1 row)
    7. postgres=# SELECT typlen FROM pg_type WHERE oid = pg_typeof(33);
    8.  typlen 
    9. --------
    10.       4
    11. (1 row)

  • collation for (any)

    描述：获取参数的排序

    返回类型：text

    备注：表达式collation for返回传递给他的值的排序。示例：

    1. postgres=# SELECT collation for (description) FROM pg_description LIMIT 1;
    2.  pg_collation_for 
    3. ------------------
    4.  "default"
    5. (1 row)

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

  • getdistributekey(table_name)

    描述：获取一个hash表的分布列。

    返回类型：text

    示例：

    1. postgres=# SELECT getdistributekey('item');
    2.  getdistributekey 
    3. ------------------
    4.  i_item_sk
    5. (1 row)

注释信息函数

  • col_description(table_oid, column_number)

    描述：获取一个表字段的注释

    返回类型：text

    备注：col_description返回一个表中字段的注释，通过表OID和字段号来声明。

  • obj_description(object_oid, catalog_name)

    描述：获取一个数据库对象的注释

    返回类型：text

    备注：带有两个参数的obj_description返回一个数据库对象的注释，该对象是通过其OID和其所属的系统表名称声明。比如，obj_description(123456,‘pg_class’)将返回OID为123456的表的注释。只带一个参数的obj_description只要求对象OID。

    obj_description不能用于表字段，因为字段没有自己的OID。

  • obj_description(object_oid)

    描述：获取一个数据库对象的注释

    返回类型：text

  • shobj_description(object_oid, catalog_name)

    描述：获取一个共享数据库对象的注释

    返回类型：text

    备注：shobj_description和obj_description差不多，不同之处仅在于前者用于共享对象。一些系统表是通用于openGauss中所有数据库的全局表，因此这些表的注释也是全局存储的。

事务ID和快照

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

  • pgxc_is_committed(transaction_id)

    描述：如果提交或忽略给定的XID（gxid）。NULL表示的状态是未知的（运行，准备，冻结等）。

    返回类型：bool

  • txid_current()

    描述：获取当前事务ID。

    返回类型：bigint

  • txid_current_snapshot()

    描述：获取当前快照。

    返回类型：txid_snapshot

  • txid_snapshot_xip(txid_snapshot)

    描述：在快照中获取正在进行的事务ID。

    返回类型：setof bigint

  • txid_snapshot_xmax(txid_snapshot)

    描述：获取快照的xmax。

    返回类型：bigint

  • txid_snapshot_xmin(txid_snapshot)

    描述：获取快照的xmin。

    返回类型：bigint

  • txid_visible_in_snapshot(bigint, txid_snapshot)

    描述：在快照中事务ID是否可见（不使用子事务ID）。

    返回类型：Boolean

  • get_local_prepared_xact()

    描述：获取当前节点两阶段残留事务信息，包括事务id，两阶段gid名称，prepared的时间，owner的oid，database的oid及当前节点的node_name。

    返回类型：xid, text, timestamptz, oid, oid，text

  • get_remote_prepared_xacts()

    描述：获取所有远程节点两阶段残留事务信息，包括事务id，两阶段gid名称，prepared的时间，owner的名称，database的名称及node_name。

    返回类型：xid, text, timestamptz, name, name，text

  • global_clean_prepared_xacts(text, text)

    描述：并发清理两阶段残留事务，仅gs_clean工具可以调用清理，其他用户调用均返回false。

    返回类型：Boolean

  • pgxc_stat_get_wal_senders_status()

    描述：返回节点事务日志备机接收状态。

    返回值如下：

    表 1 pgxc_stat_get_wal_senders_status返回参数说明

    字段名

    描述

    nodename

    主节点名。

    source_ip

    主节点IP。

    source_port

    主节点端口。

    dest_ip

    备节点IP。

    dest_port

    备节点端口。

    sender_pid

    发送线程PID。

    local_role

    主节点类型。

    peer_role

    备节点类型。

    peer_state

    备节点状态。

    state

    wal sender状态。

    sender_sent_location

    主节点发送位置。

    sender_write_location

    主节点落盘位置。

    sender_replay_location

    主节点redo位置。

    receiver_received_location

    备节点接收位置。

    receiver_write_location

    备节点落盘位置。

    receiver_flush_location

    备节点flush磁盘位置。

    receiver_replay_location

    备节点redo位置。

内部事务ID类型（xid）是32位，每40亿事务一次循环。这些函数使用的数据类型txid_snapshot，存储在特定时刻事务ID可见性的信息。其组件描述在表2。

表 2 快照组件

名称

描述

xmin

最早的事务ID（txid）仍然活动。所有较早事务将是已经提交可见的，或者是直接回滚。

xmax

作为尚未分配的txid。所有大于或等于此txids的都是尚未开始的快照时间，因此不可见。

xip_list

当前快照中活动的txids。这个列表只包含在xmin和xmax之间活动的txids；有可能活动的txids高于xmax。 介于大于等于xmin、小于xmax，并且不在这个列表中的txid，在这个时间快照已经完成的，因此按照提交状态查看他是可见还是回滚。这个列表不包含子事务的txids。

txid_snapshot的文本表示为：xmin:xmax:xip_list。

示例：10:20:10,14,15意思为：xmin=10, xmax=20, xip_list=10, 14, 15。