华为云用户手册

注释信息函数 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差不多，不同之处仅在于前者用于共享对象。一些系统表是通用于集群中所有数据库的全局表，因此这些表的注释也是全局存储的。

模式可见性查询函数 每个函数执行检查数据库对象类型的可见性。对于函数和操作符，如果在前面的搜索路径中没有相同的对象名称和参数的数据类型，则此对象是可见的。对于操作符类，则要同时考虑名称和相关索引的访问方法。 所有这些函数都需要使用OID来标识要需要检查的对象。如果用户想通过名称测试对象，则使用OID别名类型（regclass、regtype、regprocedure、regoperator、regconfig或regdictionary）将会很方便。 比如，如果一个表所在的模式在搜索路径中，并且在前面的搜索路径中没有同名的表，则这个表是可见的。它等效于表可以不带明确模式修饰进行引用。比如，要列出所有可见表的名称： 1 openGauss=# 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字节。 12345 openGauss=# SELECT format_type((SELECT oid FROM pg_type WHERE typname='varchar'), 10); format_type ---------------------- character varying(6)(1 row) pg_check_authid(role_oid) 描述：检查是否存在给定oid的角色名 返回类型：bool openGauss=# select pg_check_authid(1);pg_check_authid-----------------f(1 row) 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 示例： openGauss=# select * from pg_get_functiondef(598); headerlines | definition -------------+---------------------------------------------------- 4 | CREATE OR REPLACE FUNCTION pg_catalog.abbrev(inet)+ | RETURNS text + | LANGUAGE internal + | IMMUTABLE STRICT NOT FENCED NOT SHIPPABLE + | AS $function$inet_abbrev$function$ + | (1 row) 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 示例： openGauss=# select * from pg_get_indexdef(16416); pg_get_indexdef ------------------------------------------------------------------------- CREATE INDEX test3_b_idx ON test3 USING btree (b) TABLESPACE pg_default(1 row) pg_get_indexdef(index_oid, dump_schema_only) 描述：获取索引的CREATE INDEX命令，仅用于dump场景。当前版本dump_schema_only参数取值对函数输出结果无影响。 返回类型：text 示例： openGauss=# select * from pg_get_indexdef(16416, true); pg_get_indexdef ------------------------------------------------------------------------- CREATE INDEX test3_b_idx ON test3 USING btree (b) TABLESPACE pg_default(1 row) pg_get_indexdef(index_oid, column_no, pretty_bool) 描述：获取索引的CREATE INDEX命令，或者如果column_no不为零，则只获取一个索引字段的定义。 返回类型：text 示例： openGauss=# select * from pg_get_indexdef(16416, 0, false); pg_get_indexdef ------------------------------------------------------------------------- CREATE INDEX test3_b_idx ON test3 USING btree (b) TABLESPACE pg_default(1 row)openGauss=# select * from pg_get_indexdef(16416, 1, false); pg_get_indexdef ----------------- b(1 row) 备注：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_ruledef(rule_oid) 描述：获取规则的CREATE RULE命令 返回类型：text pg_get_ruledef(rule_oid, pretty_bool) 描述：获取规则的CREATE RULE命令 返回类型：text pg_get_userbyid(role_oid) 描述：获取给定OID的角色名 返回类型：name 备注：pg_get_userbyid通过角色的OID抽取对应的用户名。 pg_check_authid(role_id) 描述：通过role_id检查用户是否存在 返回类型：text openGauss=# select pg_check_authid(20);pg_check_authid-----------------f(1 row) 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 示例： openGauss=# select * from pg_get_tabledef(16384); pg_get_tabledef ------------------------------------------------------- SET search_path = public; + CREATE TABLE t1 ( + c1 bigint DEFAULT nextval('serial'::regclass)+ ) + WITH (orientation=row, compression=no) + DISTRIBUTE BY HASH(c1) + TO GROUP group1;(1 row) pg_get_tabledef(table_name) 描述：根据table_name获取表定义。 返回类型：text 示例： openGauss=# select * from pg_get_tabledef('t1'); pg_get_tabledef ------------------------------------------------------- SET search_path = public; + CREATE TABLE t1 ( + c1 bigint DEFAULT nextval('serial'::regclass)+ ) + WITH (orientation=row, compression=no) + DISTRIBUTE BY HASH(c1) + TO GROUP group1;(1 row) 备注：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 2 3 4 5 6 7 8 91011 openGauss=# SELECT pg_typeof(33); pg_typeof ----------- integer(1 row)openGauss=# SELECT typlen FROM pg_type WHERE oid = pg_typeof(33); typlen -------- 4(1 row) collation for (any) 描述：获取参数的排序 返回类型：text 备注：表达式collation for返回传递给他的值的排序。示例： 12345 openGauss=# SELECT collation for (description) FROM pg_description LIMIT 1; pg_collation_for ------------------ "default"(1 row) 值可能是引号括起来的并且模式限制的。如果没有为参数表达式排序，则返回一个null值。如果参数不是排序的类型，则抛出一个错误。 getdistributekey(table_name) 描述：获取一个hash表的分布列。 返回类型：text 示例： 12345 openGauss=# SELECT getdistributekey('item'); getdistributekey ------------------ i_item_sk(1 row)

访问权限查询函数 DDL类权限ALTER、DROP、COMMENT、INDEX、VACUUM属于所有者固有的权限，隐式拥有。 以下访问权限查询函数仅表示用户是否具有某对象上的某种对象权限，即返回记录在系统表acl字段中的对象权限拥有情况。 has_any_column_privilege(user, table, privilege) 描述：指定用户是否有访问表任何列的权限。 表2 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或id。 table text，oid 表 表名称或表id。 privilege text 权限 SELECT：允许对指定表任何列执行SELECT语句。 INSERT：允许对指定表任何列执行INSERT语句。 UPDATE：允许对指定表任何列任意字段执行UPDATE语句。 REFERENCES：允许创建一个外键约束。 COMMENT：允许对指定表任何列执行COMMENT语句。 返回类型：Boolean has_any_column_privilege(table, privilege) 描述：当前用户是否有访问表任何列的权限，合法参数类型见表2。 返回类型：Boolean 备注：has_any_column_privilege检查用户是否以特定方式访问表的任何列。其参数可能与has_table_privilege类似，除了访问权限类型必须是SELECT、INSERT、UPDATE或REFERENCES的一些组合。 拥有表的表级别权限则隐含的拥有该表每列的列级权限，因此如果与has_table_privilege参数相同，has_any_column_privilege总是返回true。但是如果授予至少一列的列级权限也返回成功。 has_column_privilege(user, table, column, privilege) 描述：指定用户是否有访问列的权限。 表3 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或者id。 table text，oid 表名 表的名字或id。 column text，smallint 列名 列的名字或属性号。 privilege text 权限 SELECT：允许对表的指定列执行SELECT语句。 INSERT：允许对表的指定列执行INSERT语句。 UPDATE：允许对表的指定列执行UPDATE语句。 REFERENCES：允许创建一个外键约束。 COMMENT：允许对表的指定列执行COMMENT语句。 返回类型：Boolean has_column_privilege(table, column, privilege) 描述：当前用户是否有访问列的权限，合法参数类型见表3。 返回类型：Boolean 备注：has_column_privilege检查用户是否以特定方式访问一列。其参数类似于has_table_privilege，可以通过列名或属性号添加列。想要的访问权限类型必须是SELECT、INSERT、UPDATE或REFERENCES的一些组合。 拥有表的表级别权限则隐含的拥有该表每列的列级权限。 has_cek_privilege(user, cek, privilege) 描述：指定用户是否有访问列加密密钥CEK的权限。 表4 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或id。 cek text，oid 列加密密钥 列加密密钥名称或id。 privilege text 权限 USAGE：允许使用指定列加密密钥。 DROP：允许删除指定列加密密钥。 返回类型：Boolean has_cmk_privilege(user, cmk, privilege) 描述：指定用户是否有访问客户端加密主密钥CMK的权限。 表5 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或id。 cmk text，oid 客户端加密主密钥 客户端加密主密钥名称或id。 privilege text 权限 USAGE：允许使用指定客户端加密主密钥。 DROP：允许删除指定客户端加密主密钥。 返回类型：Boolean has_database_privilege(user, database, privilege) 描述：指定用户是否有访问数据库的权限。 表6 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或id。 database text，oid 数据库 数据库名字或id。 privilege text 权限 CREATE：对于数据库，允许在数据库里创建新的模式。 TEMPORARY：允许在使用数据库的时候创建临时表。 TEMP：允许在使用数据库的时候创建临时表。 CONNECT：允许用户连接到指定的数据库。 ALTER：允许用户修改指定对象的属性。 DROP：允许用户删除指定的对象。 COMMENT：允许用户定义或修改指定对象的注释。 返回类型：Boolean has_database_privilege(database, privilege) 描述：当前用户是否有访问数据库的权限，合法参数类型见表6。 返回类型：Boolean 备注：has_database_privilege检查用户是否能以在特定方式访问数据库。其参数类似has_table_privilege。访问权限类型必须是CREATE、CONNECT、TEMPORARY或TEMP（等价于TEMPORARY）的一些组合。 has_directory_privilege(user, directory, privilege) 表7 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或id。 directory text，oid 目录 目录名字或者oid。 privilege text 权限 READ：允许对该目录进行读操作。 WRITE:允许对该目录进行写操作。 描述：指定用户是否有访问directory的权限。 返回类型：Boolean has_directory_privilege(directory, privilege) 描述：当前用户是否有访问directory的权限，合法参数类型见表7。 返回类型：Boolean has_foreign_data_wrapper_privilege(user, fdw, privilege) 表8 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或者id。 fdw text，oid 外部数据封装器 外部数据封装器名字或id。 privilege text 权限 USAGE：允许访问外部数据封装器。 描述：指定用户是否有访问外部数据封装器的权限。 返回类型：Boolean has_foreign_data_wrapper_privilege(fdw, privilege) 描述：当前用户是否有访问外部数据封装器的权限，合法参数类型见表8。 返回类型：Boolean 备注：has_foreign_data_wrapper_privilege检查用户是否能以特定方式访问外部数据封装器。其参数类似has_table_privilege。访问权限类型必须是USAGE。 has_function_privilege(user, function, privilege) 表9 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或者id function text，oid 函数 函数名称或id privilege text 权限 EXECUTE：允许使用指定的函数，以及利用这些函数实现的操作符。 ALTER：允许用户修改指定对象的属性。 DROP：允许用户删除指定的对象。 COMMENT：允许用户定义或修改指定对象的注释。 描述：指定用户是否有访问函数的权限。 返回类型：Boolean has_function_privilege(function, privilege) 描述：当前用户是否有访问函数的权限。合法参数类型见表9。 返回类型：Boolean 备注：has_function_privilege检查一个用户是否能以指定方式访问一个函数。其参数类似has_table_privilege。使用文本字符而不是OID声明一个函数时，允许输入的类型和regprocedure数据类型一样（请参考对象标识符类型）。访问权限类型必须是EXECUTE。 has_language_privilege(user, language, privilege) 表10 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或id。 language text，oid 语言 语言名称或id。 privilege text 权限 USAG：对于过程语言，允许用户在创建函数的时候指定过程语言。 描述：指定用户是否有访问语言的权限。 返回类型：Boolean has_language_privilege(language, privilege) 描述：当前用户是否有访问语言的权限。合法参数类型见表10。 返回类型：Boolean 备注：has_language_privilege检查用户是否能以特定方式访问一个过程语言。其参数类似has_table_privilege。访问权限类型必须是USAGE。 has_nodegroup_privilege(user, nodegroup, privilege) 描述：检查用户是否有集群节点访问权限。 返回类型：Boolean 表11 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 已存在用户名称或id。 nodegroup text，oid 集群节点 已存在的集群节点。 privilege text 权限 USAGE：对于子集群，对包含在指定模式中的对象有访问权限时，USAGE允许访问指定子集群下的表对象。 CREATE：对于子集群，允许在子集群中创建表对象。 COMPUTE：针对计算子集群，允许用户在具有compute权限的计算子集群上进行弹性计算。 ALTER：允许用户修改指定对象的属性。 DROP：允许用户删除指定的对象。 has_nodegroup_privilege(nodegroup, privilege) 描述：检查用户是否有集群节点访问权限。 返回类型：Boolean has_schema_privilege(user, schema, privilege) 描述：指定用户是否有访问模式的权限。 返回类型：Boolean has_schema_privilege(schema, privilege) 描述：当前用户是否有访问模式的权限。 返回类型：Boolean 备注：has_schema_privilege检查用户是否能以特定方式访问一个模式。其参数类似has_table_privilege。访问权限类型必须是CREATE、USAGE、ALTER、DROP或COMMENT的一些组合。 has_sequence_privilege(user, sequence, privilege) 描述：指定用户是否有访问序列的权限。 返回类型：Boolean 表12 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 已存在用户名称或id。 sequence text，oid 序列 已存在序列名称或id。 privilege text 权限 USAGE：对于序列，USAGE允许使用nextval函数。 SELECT：允许创建序列。 UPDATE：允许执行UPDATE语句。 ALTER：允许用户修改指定对象的属性。 DROP：允许用户删除指定的对象。 COMMENT：允许用户定义或修改指定对象的注释。 has_sequence_privilege(sequence, privilege) 描述：指定当前用户是否有访问序列的权限。 返回类型：Boolean has_server_privilege(user, server, privilege) 描述：指定用户是否有访问外部服务的权限。 返回类型：Boolean has_server_privilege(server, privilege) 描述：当前用户是否有访问外部服务的权限。 返回类型：Boolean 备注：has_server_privilege检查用户是否能以指定方式访问一个外部服务器。其参数类似has_table_privilege。访问权限类型必须是USAGE、ALTER、DROP或COMMENT之一的值。 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、REFERENCESTRIGGER、ALTER、DROP、COMMENT、INDEX或VACUUM之一的值。可以给权限类型添加WITH GRANT OPTION，用来测试权限是否拥有授权选项。也可以用逗号分隔列出的多个权限类型，如果拥有任何所列出的权限，则结果便为true。 示例： 1 2 3 4 5 6 7 8 91011 openGauss=# SELECT has_table_privilege('tpcds.web_site', 'select'); has_table_privilege --------------------- t (1 row)openGauss=# SELECT has_table_privilege('omm', 'tpcds.web_site', 'select,INSERT WITH GRANT OPTION '); has_table_privilege --------------------- t (1 row) has_tablespace_privilege(user, tablespace, privilege) 描述：指定用户是否有访问表空间的权限。 返回类型：Boolean has_tablespace_privilege(tablespace, privilege) 描述：当前用户是否有访问表空间的权限。 返回类型：Boolean 备注：has_tablespace_privilege检查用户是否能以特定方式访问一个表空间。其参数类似has_table_privilege。访问权限类型必须是CREATE、ALTER、DROP或COMMENT之一的值。 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也直接拥有角色的使用权限。 has_any_privilege(user, privilege) 描述：指定用户是否有某项ANY权限，若同时查询多个权限，只要具有其中一个则返回true。 返回类型：Boolean 表13 参数类型说明 参数名 合法入参类型 描述 取值范围 user name 用户 已存在的用户名。 privilege text ANY权限 可选取值： CREATE ANY TABLE [WITH ADMIN OPTION] ALTER ANY TABLE [WITH ADMIN OPTION] DROP ANY TABLE [WITH ADMIN OPTION] SELECT ANY TABLE [WITH ADMIN OPTION] INSERT ANY TABLE [WITH ADMIN OPTION] UPDATE ANY TABLE [WITH ADMIN OPTION] DELETE ANY TABLE [WITH ADMIN OPTION] CREATE ANY SEQUENCE [WITH ADMIN OPTION] CREATE ANY INDEX [WITH ADMIN OPTION] CREATE ANY FUNCTION [WITH ADMIN OPTION] EXECUTE ANY FUNCTION [WITH ADMIN OPTION] CREATE ANY PACKAGE [WITH ADMIN OPTION] EXECUTE ANY PACKAGE [WITH ADMIN OPTION] CREATE ANY TYPE [WITH ADMIN OPTION]

会话信息函数 current_catalog 描述：当前数据库的名称（在标准SQL中称"catalog"）。 返回值类型：name 示例： 12345 openGauss=# SELECT current_catalog; current_database------------------ postgres(1 row) current_database() 描述：当前数据库的名称。 返回值类型：name 示例： 12345 openGauss=# SELECT current_database(); current_database------------------ postgres(1 row) current_query() 描述：由客户端提交的当前执行语句（可能包含多个声明）。 返回值类型：text 示例： 12345 openGauss=# SELECT current_query(); current_query------------------------- SELECT current_query();(1 row) current_schema[()] 描述：当前模式的名称。 返回值类型：name 示例： 12345 openGauss=# SELECT current_schema(); current_schema---------------- public(1 row) 备注：current_schema返回在搜索路径中第一个顺位有效的模式名。（如果搜索路径为空则返回NULL，没有有效的模式名也返回NULL）。如果创建表或者其他命名对象时没有声明目标模式，则将使用这些对象的模式。 current_schemas(Boolean) 描述：搜索路径中的模式名称。 返回值类型：name[] 示例： 12345 openGauss=# SELECT current_schemas(true); current_schemas--------------------- {pg_catalog,public}(1 row) 备注： current_schemas(Boolean)返回搜索路径中所有模式名称的数组。布尔选项决定像pg_catalog这样隐含包含的系统模式是否包含在返回的搜索路径中。 搜索路径可以通过运行时设置更改。命令是： 1 SET search_path TO schema [, schema, ...] current_user 描述：当前执行环境下的用户名。 返回值类型：name 示例： 12345 openGauss=# SELECT current_user; current_user-------------- omm(1 row) 备注：current_user是用于权限检查的用户标识。通常，他表示会话用户，但是可以通过SET ROLE改变他。在函数执行的过程中随着属性SECURITY DEFINER的改变，其值也会改变。 definer_current_user 描述：当前执行环境下的用户名。 返回值类型：name 示例： 12345 openGauss=# SELECT definer_current_user(); definer_current_user---------------------- omm(1 row) 备注：大多数情况下definer_current_user和current_user结果相同，但在存储过程中执行该函数会返回定义当前存储过程的用户名。 pg_current_sessionid() 描述：当前执行环境下的会话ID。 返回值类型：text 示例： 12345 openGauss=# SELECT pg_current_sessionid(); pg_current_sessionid---------------------------- 1579228402.140190434944768(1 row) 备注：pg_current_sessionid()是用于获取当前执行环境下的会话ID。其组成结构为：时间戳.会话ID，当线程池模式开启（enable_thread_pool=on）时，会话ID为SessionID；而线程池模式关闭时，会话ID实际为线程ID。 pg_current_sessid 描述：当前执行环境下的会话ID。 返回值类型：text 示例： openGauss=# select pg_current_sessid();pg_current_sessid-------------------140308875015936(1 row) 备注：在线程池模式下获得当前会话的会话ID，非线程池模式下获得当前会话对应的后台线程ID。 pg_current_userid 描述：当前用户ID。 返回值类型：text 示例： openGauss=# SELECT pg_current_userid();pg_current_userid-------------------10(1 row) tablespace_oid_name() 描述：根据表空间oid，查找表空间名称。 返回值类型：text 示例： 12345 openGauss=# select tablespace_oid_name(1663); tablespace_oid_name--------------------- pg_default(1 row) inet_client_addr() 描述：连接的远端地址。inet_client_addr返回当前客户端的IP地址。 此函数只有在远程连接模式下有效。 返回值类型：inet 示例： 12345 openGauss=# SELECT inet_client_addr(); inet_client_addr------------------ 10.10.0.50(1 row) inet_client_port() 描述：连接的远端端口。inet_client_port返回当前客户端的端口号。 此函数只有在远程连接模式下有效。 返回值类型：int 示例： 12345 openGauss=# SELECT inet_client_port(); inet_client_port------------------ 33143(1 row) inet_server_addr() 描述：连接的本地地址。inet_server_addr返回服务器接收当前连接用的IP地址。 此函数只有在远程连接模式下有效。 返回值类型：inet 示例： 12345 openGauss=# SELECT inet_server_addr(); inet_server_addr------------------ 10.10.0.13(1 row) inet_server_port() 描述：连接的本地端口。inet_server_port返回接收当前连接的端口号。如果是通过Unix-domain socket连接的，则所有这些函数都返回NULL。 此函数只有在远程连接模式下有效。 返回值类型：int 示例： 12345 openGauss=# SELECT inet_server_port(); inet_server_port------------------ 8000(1 row) pg_backend_pid() 描述：当前会话连接的服务进程的进程ID。 返回值类型：int 示例： 12345 openGauss=# SELECT pg_backend_pid(); pg_backend_pid----------------- 140229352617744(1 row) pg_conf_load_time() 描述：配置加载时间。pg_conf_load_time返回最后加载服务器配置文件的时间戳。 返回值类型：timestamp with time zone 示例： 12345 openGauss=# SELECT pg_conf_load_time(); pg_conf_load_time ------------------------------ 2017-09-01 16:05:23.89868+08(1 row) pg_my_temp_schema() 描述：会话的临时模式的OID，不存在则为0。 返回值类型：oid 示例： 12345 openGauss=# SELECT pg_my_temp_schema(); pg_my_temp_schema ------------------- 0(1 row) 备注：pg_my_temp_schema返回当前会话中临时模式的OID，如果不存在（没有创建临时表）的话则返回0。如果给定的OID是其它会话中临时模式的OID，pg_is_other_temp_schema则返回true。 pg_is_other_temp_schema(oid) 描述：是否为另一个会话的临时模式。 返回值类型：Boolean 示例： 12345 openGauss=# SELECT pg_is_other_temp_schema(25356); pg_is_other_temp_schema------------------------- f(1 row) pg_listening_channels() 描述：会话正在侦听的信道名称。 返回值类型：setof text 示例： 1234 openGauss=# SELECT pg_listening_channels(); pg_listening_channels-----------------------(0 rows) 备注：pg_listening_channels返回当前会话正在侦听的一组信道名称。 pg_postmaster_start_time() 描述：服务器启动时间。pg_postmaster_start_time返回服务器启动时的timestamp with time zone。 返回值类型：timestamp with time zone 示例： 12345 openGauss=# SELECT pg_postmaster_start_time(); pg_postmaster_start_time ------------------------------ 2017-08-30 16:02:54.99854+08(1 row) sessionid2pid() 描述：从sessionid中得到pid信息（如: pv_session_stat中sessid列）。 返回值类型：int8 示例： 123456 openGauss=# select sessionid2pid(sessid::cstring) from pv_session_stat limit 2; sessionid2pid----------------- 139973107902208 139973107902208(2 rows) session_context( 'namespace' , 'parameter') 描述：获取并返回指定namespace下参数parameter的值。 返回值类型：VARCHAR 示例： 12345 openGauss=# SELECT session_context('USERENV', 'CURRENT_SCHEMA'); session_context ------------- public(1 row) 根据当前所在的实际schema而变化。 备注：目前仅支持SESSION_CONTEXT('USERENV', 'CURRENT_SCHEMA') 和SESSION_CONTEXT('USERENV', 'CURRENT_USER')两种格式。 pg_trigger_depth() 描述：触发器的嵌套层次。 返回值类型：int 示例： 12345 openGauss=# SELECT pg_trigger_depth(); pg_trigger_depth ------------------ 0(1 row) opengauss_version() 描述：引用的openGauss内核版本信息。 返回值类型：text 示例： 12345 openGauss=# SELECT opengauss_version(); opengauss_version------------------- 2.0.0(1 row) gs_deployment() 描述：当前系统的部署形态信息，对于分布式系统来说返回的是“Distribute”。 返回值类型：text 示例： 12345 openGauss=# select gs_deployment(); gs_deployment--------------- Distribute(1 row) session_user 描述：会话用户名。 返回值类型：name 示例： 12345 openGauss=# SELECT session_user; session_user-------------- omm(1 row) 备注：session_user通常是连接当前数据库的初始用户，不过系统管理员可以用SET SESSION AUTHORIZATION修改这个设置。 user 描述：等价于current_user。 返回值类型：name 示例： 12345 openGauss=# SELECT user; current_user-------------- omm(1 row) get_shard_oids_byname 描述：输入node的名字返回node的oid。 返回值类型：oid 示例： 12345 openGauss=# select get_shard_oids_byname('datanode1'); get_shard_oids_byname----------------------- {16385}(1 row) getpgusername() 描述：获取数据库用户名。 返回值类型：name 示例： 12345 openGauss=# select getpgusername(); getpgusername --------------- GaussDB_userna(1 row) getdatabaseencoding() 描述：获取数据库编码方式。 返回值类型：name 示例： 12345 openGauss=# select getdatabaseencoding(); getdatabaseencoding --------------------- SQL_ASCII(1 row) version() 描述：版本信息。version返回一个描述服务器版本信息的字符串。 返回值类型：text 示例： 12345 openGauss=# SELECT version(); version----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- openGauss 2.0.0 (GaussDBl VxxxRxxxCxx build f521c606) compiled at 2021-09-16 14:55:22 commit 2935 last mr 6385 release(1 row)

故障注入系统函数 gs_fault_inject(int64, text, text, text, text, text) 描述：该函数不能调用，调用时会报WARNING信息："unsupported fault injection"，并不会对数据库产生任何影响和改变。 参数：int64注入故障类型（0：CLOG扩展页面，1：读取CLOG页面，2：强制死锁）。 text第二个入参在第一入参为2的模式下若为“1”则死锁，其余不死锁；第二个入参在第一入参为0，1时，表示CLOG开始扩展或读取的起始页面号。 text第三个入参在第一入参为0，1时，表示扩展或读取的页面个数。 text第四到六入参为预留参数。 返回值类型：int64 父主题： 函数和操作符

提示信息函数 report_application_error 描述：PL执行过程中，可以使用此函数来抛ERROR。 返回值类型：void 表1 report_application_error参数说明 参数 类型 说明 是否必选 log text error消息的内容。 是 code int4 error消息对应的error code，范围为：-20999 ~ -20000。 否 父主题： 函数和操作符

段页式存储函数 local_segment_space_info(tablespacename TEXT, databasename TEXT) 描述：输出为当前节点，该表空间下所有ExtentGroup的使用信息。 返回值类型： node_name 节点名称 extent_size 该ExtentGroup的extent规格，单位是block数。 forknum Fork号 total_blocks 物理文件总extent数目。 meta_data_blocks 表空间管理的metadata占用的block数，只包括space header，map page等，不包括segment head。 used_data_blocks 存数据占用的extent数目。包括segment head。 utilization 使用的block数占总block数的百分比。即(used_data_blocks+meta_data_block)/total_blocks。 high_water_mark 高水位线，被分配出去的extent，最大的物理页号。超过高水位线的block都没有被使用，可以被直接回收。 例如： select * from local_segment_space_info('pg_default', 'postgres'); node_name | extent_size | forknum | total_blocks | meta_data_blocks | used_data_blocks | utilization | high_water_mark -------------------+-------------+---------+--------------+------------------+------------------+-------------+----------------- dn_6001_6002_6003 | 1 | 0 | 16384 | 4157 | 1 | .253784 | 4158 dn_6001_6002_6003 | 8 | 0 | 16384 | 4157 | 8 | .254211 | 4165(2 rows) global_segment_space_info(tablespacename TEXT, databasename TEXT) 描述：效果跟local_segment_space_info类似，返回的是整个集群中所有节点上的使用信息。 pg_stat_segment_extent_usage(int4 tablespace oid, int4 database oid, int4 extent_type, int4 forknum) 描述：每次返回一个ExtentGroup中，每个被分配出去的extent的使用情况。extent_type表示ExtentGroup的类型，合理取值为[1,5]的int值。在此范围外的会报error。forknum 表示fork号，合法取值为[0,4]的int值，目前只有三种值有效，数据文件为0，FSM文件为1，visibility map文件为2。 返回值类型： 名称 描述 start_block Extent的起始物理页号。 extent_size Extent的大小。 usage_type Extent的使用类型，比如segment head，data extent等。 ower_location 有指针指向该extent的对象的位置。比如data extent的owner就是它所属的segment的head位置。 special_data 该extent在它owner中的位置。该字段的数据跟使用类型有关。比如data extent的special data就是它在所属segment中的extent id。 其中，usage_type为枚举类型，每一项的含义为： Non-bucket table segment head ：非hashbucket表的数据段头。 Non-bucket table fork head：非段页式表的fork段头。 Bucket table main head：hashbucket表的主表段头。 Bucket table map block：hashbucket表的MapBlock。 Bucket segment head：hashbucket表每个bucket的段头。 Data extent：数据块。 例如： select * from pg_stat_segment_extent_usage((select oid::int4 from pg_tablespace where spcname='pg_default'), (select oid::int4 from pg_database where datname='postgres'), 1, 0);start_block | extent_size | usage_type | ower_location | special_data-------------+-------------+------------------------+---------------+--------------4157 | 1 | Bucket table main head | 4294967295 | 04158 | 1 | Bucket table map block | 4157 | 04159 | 1 | Bucket table map block | 4157 | 14160 | 1 | Bucket table map block | 4157 | 24161 | 1 | Bucket table map block | 4157 | 34162 | 1 | Bucket table map block | 4157 | 44163 | 1 | Bucket table map block | 4157 | 54164 | 1 | Bucket table map block | 4157 | 64165 | 1 | Bucket table map block | 4157 | 74166 | 1 | Bucket table map block | 4157 | 8 local_space_shrink(tablespacename TEXT, databasename TEXT) 描述：当前节点上对指定段页式空间做物理空间收缩。注意，目前只支持对当前连接的database做shrink。 返回值：空 gs_space_shrink(int4 tablespace, int4 database, int4 extent_type, int4 forknum) 描述：效果跟local_space_shrink类似，对指定段页式空间做物理空间收缩，但参数不同，传入的是tablespace和database的oid，extent_type为[2,5]的int值。注意：extent_type = 1表示段页式元数据，目前不支持对元数据所在的物理文件做收缩。该函数仅限工具使用，不建议用户直接使用。 返回值：空 global_space_shrink(tablespacename TEXT, databasename TEXT) 描述：在cn上执行，对整个集群上所有dn执行段页式存储空间压缩。 注意：global_space_shrink 锁cluster，在此期间不能执行DDL操作。而local_space_shrink不会锁集群。 pg_stat_remain_segment_info() 描述：展示在当前节点上，因为故障等原因，残留的extent。残留extent主要分为两类：分配而未被利用的segment和分配出去而未被利用的extent。两者主要区别在于segment会包含多个extent，回收时，要将segment上的extent一并全部回收。 返回值类型： 名称 描述 space_id 表空间ID db_id 数据库ID block_id Extent的ID type Extent的类型，当前有三种：ALLOC_SEGMENT|DROP_SEGMENT|SHRINK_EXTENT 其中type的三种类型分别表示： ALLOC_SEGMENT:用户创建一张段页式表，当segment刚被分配，但是建表语句所在事务仍未提交时，节点故障，导致该segment被分配后，没有被使用。 DROP_SEGMENT:用户删除段页式表，当该事务成功提交，但是此表的segment页面对应的bit位未被重置，就发生掉电等故障，造成该segment未被使用，也未被释放。 SHRINK_EXTENT:用户对段页式表执行shrink操作，在未对空置出的extent进行释放时，发生掉电等故障，造成该extent残留，无法被重新利用。 例如： select * from pg_stat_remain_segment_info();space_id | db_id | block_id | type----------+-------+----------+------1663 | 16385| 4156| ALLOC_SEGMENT pg_free_remain_segment(int4 spaceId, int4 dbId, int4 segmentId) 描述：释放指定的残留extent。参数取值必须为从函数pg_stat_remain_segment_info中查询获取。函数会对传入值校验，如果指定extent不在记录的残留extent中，将返回错误信息。指定的extent如果为单个extent，则只将其独自释放；如果为一个segment，则会将此segment以及此segment上记录的所有extent释放。 返回值：空 父主题： 系统管理函数

逻辑复制函数 pg_create_logical_replication_slot('slot_name', 'plugin_name') 描述：创建逻辑复制槽。 参数说明： slot_name 流复制槽名称。 取值范围：字符串，仅支持小写字母，数字，以及_?-.字符，且不支持“.”或“..”单独作为复制槽名称。 plugin_name 插件名称。 取值范围：字符串，当前只支持“mppdb_decoding”。 返回值类型：name, text 备注：第一个返回值表示slot_name，第二个返回值表示该逻辑复制槽解码的起始LSN位置。调用该函数的用户需要具有SYSADMIN权限或具有REPLICATION权限或继承了内置角色gs_role_replication的权限。 pg_create_physical_replication_slot('slot_name', 'isDummyStandby') 描述：创建新的物理复制槽。 参数说明： slot_name 流复制槽名称。 取值范围：字符串，仅支持小写字母，数字，以及_?-.字符，且不支持“.”或“..”单独作为复制槽名称。 isDummyStandby 是否是从从备连接主机创建的复制槽。 类型：Boolean 返回值类型：name，text 备注：调用该函数的用户需要具有SYSADMIN权限或具有REPLICATION权限或继承了内置角色gs_role_replication的权限。 pg_drop_replication_slot('slot_name') 描述：删除流复制槽。 参数说明： slot_name 流复制槽名称。 取值范围：字符串，仅支持小写字母，数字，以及_?-.字符，且不支持“.”或“..”单独作为复制槽名称。 返回值类型：void 备注：调用该函数的用户需要具有SYSADMIN权限或具有REPLICATION权限或继承了内置角色gs_role_replication的权限。 pg_logical_slot_peek_changes('slot_name', 'LSN', upto_nchanges, 'options_name', 'options_value') 描述：解码并不推进流复制槽（下次解码可以再次获取本次解出的数据）。 参数说明： slot_name 流复制槽名称。 取值范围：字符串，仅支持小写字母，数字，以及_?-.字符，且不支持“.”或“..”单独作为复制槽名称。 LSN 日志的LSN，表示只解码小于等于此LSN的日志。 取值范围：字符串（LSN，格式为xlogid/xrecoff），如'1/2AAFC60'。为NULL时表示不对解码截止的日志位置做限制。 upto_nchanges 解码条数（包含begin和commit）。假设一共有三条事务，分别包含3、5、7条记录，如果upto_nchanges为4，那么会解码出前两个事务共8条记录。解码完第二条事务时发现解码条数记录大于等于upto_nchanges，会停止解码。 取值范围：非负整数。 LSN和upto_nchanges中任一参数达到限制，解码都会结束。 options：此项为可选参数，由一系列options_name和options_value一一对应组成。 include-xids 解码出的data列是否包含xid信息。 取值范围：0或1，默认值为1。 0：设为0时，解码出的data列不包含xid信息。 1：设为1时，解码出的data列包含xid信息。 skip-empty-xacts 解码时是否忽略空事务信息。 取值范围：0或1，默认值为0。 0：设为0时，解码时不忽略空事务信息。 1：设为1时，解码时会忽略空事务信息。 include-timestamp 解码信息是否包含commit时间戳。 取值范围：0或1，默认值为0。 0：设为0时，解码信息不包含commit时间戳。 1：设为1时，解码信息包含commit时间戳。 only-local 是否仅解码本地日志。 取值范围：0或1，默认值为1。 0：设为0时，解码非本地日志和本地日志。 1：设为1时，仅解码本地日志。 force-binary 是否以二进制格式输出解码结果 取值范围：0，默认值为0。 0：设为0时，以文本格式输出解码结果。 white-table-list 白名单参数，包含需要进行解码的schema和表名。 取值范围：包含白名单中表名的字符串，不同的表以','为分隔符进行隔离；使用'*'来模糊匹配所有情况；schema名和表名间以'.'分割，不允许存在任意空白符。例：select * from pg_logical_slot_peek_changes('slot1', NULL, 4096, 'white-table-list', 'public.t1,public.t2'); max-txn-in-memory 内存管控参数，单位为MB，单个事务占用内存大于该值即进行落盘。 取值范围：0~100的整型，默认值为0，即不开启此种管控。 max-reorderbuffer-in-memory 内存管控参数，单位为GB，拼接-发送线程中正在拼接的事务总内存（包含缓存）大于该值则对当前解码事务进行落盘。 取值范围：0~100的整型，默认值为0，即不开启此种管控。 返回值类型：text, xid, text 备注：函数返回解码结果，每一条解码结果包含三列，对应上述返回值类型，分别表示LSN位置、xid和解码内容。调用该函数的用户需要具有SYSADMIN权限或具有REPLICATION权限或继承了内置角色gs_role_replication的权限。 pg_logical_slot_get_changes('slot_name', 'LSN', upto_nchanges, 'options_name', 'options_value') 描述：解码并推进流复制槽。 参数说明： 与pg_logical_slot_peek_changes一致，详细内容请参见•pg_logical_slot_peek_ch...。 备注：调用该函数的用户需要具有SYSADMIN权限或具有REPLICATION权限或继承了内置角色gs_role_replication的权限。 pg_logical_slot_peek_binary_changes('slot_name', 'LSN', upto_nchanges, 'options_name', 'options_value') 描述：以二进制格解码且不推进流复制槽（下次解码可以再次获取本次解出的数据）。 参数说明： slot_name 流复制槽名称。 取值范围：字符串，仅支持小写字母，数字，以及_?-.字符，且不支持“.”或“..”单独作为复制槽名称。 LSN 日志的LSN，表示只解码小于等于此LSN的日志。 取值范围：字符串（LSN，格式为xlogid/xrecoff），如'1/2AAFC60'。为NULL时表示不对解码截止的日志位置做限制。 upto_nchanges 解码条数（包含begin和commit）。假设一共有三条事务，分别包含3、5、7条记录，如果upto_nchanges为4，那么会解码出前两个事务共8条记录。解码完第二条事务时发现解码条数记录大于等于upto_nchanges，会停止解码。 取值范围：非负整数。 LSN和upto_nchanges中任一参数达到限制，解码都会结束。 options：此项为可选参数，由一系列options_name和options_value一一对应组成。 include-xids 解码出的data列是否包含xid信息。 取值范围：0或1，默认值为1。 0：设为0时，解码出的data列不包含xid信息。 1：设为1时，解码出的data列包含xid信息。 skip-empty-xacts 解码时是否忽略空事务信息。 取值范围：0或1，默认值为0。 0：设为0时，解码时不忽略空事务信息。 1：设为1时，解码时会忽略空事务信息。 include-timestamp 解码信息是否包含commit时间戳。 取值范围：0或1，默认值为0。 0：设为0时，解码信息不包含commit时间戳。 1：设为1时，解码信息包含commit时间戳。 only-local 是否仅解码本地日志。 取值范围：0或1，默认值为1。 0：设为0时，解码非本地日志和本地日志。 1：设为1时，仅解码本地日志。 force-binary 是否以二进制格式输出解码结果。 取值范围：0或1，默认值为0，均以二进制格式输出结果。 white-table-list 白名单参数，包含需要进行解码的schema和表名。 取值范围：包含白名单中表名的字符串，不同的表以','为分隔符进行隔离；使用'*'来模糊匹配所有情况；schema名和表名间以'.'分割，不允许存在任意空白符。例：select * from pg_logical_slot_peek_binary_changes('slot1', NULL, 4096, 'white-table-list', 'public.t1,public.t2'); 返回值类型：text, xid, bytea 备注：函数返回解码结果，每一条解码结果包含三列，对应上述返回值类型，分别表示LSN位置、xid和二进制格式的解码内容。调用该函数的用户需要具有SYSADMIN权限或具有REPLICATION权限或继承了内置角色gs_role_replication的权限。 pg_logical_slot_get_binary_changes('slot_name', 'LSN', upto_nchanges, 'options_name', 'options_value') 描述：以二进制格式解码并推进流复制槽。 参数说明：与pg_logical_slot_peek_binary_changes一致，详细内容请参见•pg_logical_slot_peek_bi...。 备注：调用该函数的用户需要具有SYSADMIN权限或具有REPLICATION权限或继承了内置角色gs_role_replication的权限。 pg_replication_slot_advance ('slot_name', 'LSN') 描述：直接推进流复制槽到指定LSN，不输出解码结果。 参数说明： slot_name 流复制槽名称。 取值范围：字符串，不支持除小写字母，数字,以及_?-.以外的字符，且不支持'.'或'..'单独作为复制槽名称。 LSN 推进到的日志LSN位置，下次解码时只会输出提交位置比该LSN大的事务结果。如果输入的LSN比当前流复制槽记录的推进位置还要小，则直接返回；如果输入的LSN比当前最新物理日志LSN还要大，则推进到当前最新物理日志LSN。 取值范围：字符串（LSN，格式为xlogid/xrecoff）。 返回值类型：name, text 备注：返回值分别对应slot_name和实际推进至的LSN。调用该函数的用户需要具有SYSADMIN权限或具有REPLICATION权限或继承了内置角色gs_role_replication的权限。 pg_get_replication_slots() 描述：获取复制槽列表。 示例： openGauss=# select * from pg_get_replication_slots(); slot_name | plugin | slot_type | datoid | active | xmin | catalog_xmin | restart_lsn | dummy_standby | confirmed_flush-----------+----------------+-----------+--------+--------+------+--------------+-------------+---------------+----------------- dn_s1 | | physical | 0 | t | | | 0/23DB14E0 | f | slot1 | mppdb_decoding | logical | 16304 | f | | 60966 | 0/1AFA1BB0 | f | 0/23DA5700(2 rows) 返回值: text, text, text, oid, boolean, xid, xid, text, boolean, text pg_logical_get_area_changes('LSN_start', 'LSN_end', upto_nchanges, 'decoding_plugin', 'xlog_path', 'options_name', 'options_value') 描述：没有ddl的前提下，指定lsn区间进行解码，或者指定xlog文件进行解码。 约束条件如下： 1. 调用接口时，日志级别wal_level=logical，且只有在wal_level=logical期间产生的日志文件才能被解析，如果使用的xlog文件为非logical级别，则解码内容没有对应的值和类型，无其他影响。 2. xlog文件只能被完全同构的dn的某个副本解析，确保可以找到数据对应的元信息，且没有DDL操作和VACUUM FULL。 3. 用户可以找到需要解析的xlog。 4. 用户需要注意一次不要读入过多xlog文件，推荐一次一个，一个xlog文件估测占用内存为xlog文件大小的2~3倍。 5. 无法解码扩容前的xlog文件。 备注：调用该函数的用户需要具有SYSADMIN权限或运维模式打开下的运维管理员的权限。 参数说明： LSN_start 指定开始解码的lsn。 取值范围：字符串（LSN，格式为xlogid/xrecoff），如'1/2AAFC60'。为NULL时表示不对解码截止的日志位置做限制。 LSN_end 指定解码结束的lsn。 取值范围：字符串（LSN，格式为xlogid/xrecoff），如'1/2AAFC60'。为NULL时表示不对解码截止的日志位置做限制。 upto_nchanges 解码条数（包含begin和commit）。假设一共有三条事务，分别包含3、5、7条记录，如果upto_nchanges为4，那么会解码出前两个事务共8条记录。解码完第二条事务时发现解码条数记录大于等于upto_nchanges，会停止解码。 取值范围：非负整数。 LSN和upto_nchanges中任一参数达到限制，解码都会结束。 decoding_plugin 解码插件，指定解码内容输出格式的so插件 取值范围：提供mppdb_decoding和sql_decoding两个插件。 xlog_path 解码插件，指定解码文件的xlog绝对路径，文件级别 取值范围：NULL 或者 xlog文件绝对路径的字符串。 options：此项为可选参数，由一系列options_name和options_value一一对应组成，可以缺省，详见pg_logical_slot_peek_changes。 示例： openGauss=# SELECT pg_current_xlog_location(); pg_current_xlog_location -------------------------- 0/E62E238(1 row)openGauss=# create table t1 (a int primary key,b int,c int);NOTICE: CREATE TABLE / PRIMARY KEY will create implicit index "t1_pkey" for table "t1"CREATE TABLEopenGauss=# insert into t1 values(1,1,1);INSERT 0 1openGauss=# insert into t1 values(2,2,2);INSERT 0 1openGauss=# select data from pg_logical_get_area_changes('0/E62E238',NULL,NULL,'sql_decoding',NULL); location | xid | data -----------+-------+--------------------------------------------------- 0/E62E8D0 | 27213 | COMMIT (at 2022-01-26 15:08:03.349057+08) 3020226 0/E6325F0 | 27214 | COMMIT (at 2022-01-26 15:08:07.309869+08) 3020234…… gs_get_parallel_decode_status() 描述：监控各个解码线程的读取日志队列和解码结果队列的长度，以便定位并行解码性能瓶颈。 返回值类型：text, int, text, text, text, int64, int64 示例： openGauss=# select * from gs_get_parallel_decode_status(); slot_name | parallel_decode_num | read_change_queue_length | decode_change_queue_length | reader_lsn | working_txn_cnt | working_txn_memory-----------+---------------------+---------------------------+----------------------------+------------+-----------------+-------------------- slot1 | 2 | queue0: 1005, queue1: 320 | queue0: 63, queue1: 748 | 0/1DCE2578 | 42 | 192927504(1 row) 备注：返回值的slot_name代表复制槽名，parallel_decode_num代表该复制槽的并行解码线程数，read_change_queue_length列出了每个解码线程读取日志队列的当前长度，decode_change_queue_length列出了每个解码线程解码结果队列的当前长度，reader_lsn表示当前reader线程读取的日志位置，working_txn_cnt表示当前拼接-发送线程中正在拼接的事务个数，working_txn_memory代表拼接-发送线程中拼接事务占用总内存（单位字节）。 pg_replication_origin_create (node_name) 描述：用给定的外部名称创建一个复制源，并且返回分配给它的内部ID。 备注：调用该函数的用户需要具有SYSADMIN权限。 参数说明： node_name 待创建的复制源的名称。 取值范围：字符串，不支持除字母，数字，以及（_?-.）以外的字符。 返回值类型：oid pg_replication_origin_drop (node_name) 描述：删除一个以前创建的复制源，包括任何相关的重放进度。 备注：调用该函数的用户需要具有SYSADMIN权限。 参数说明： node_name 待删除的复制源的名称。 取值范围：字符串，不支持除字母，数字，以及（_?-.）以外的字符。 pg_replication_origin_oid (node_name) 描述：根据名称查找复制源并返回内部ID。如果没有发现这样的复制源，则抛出错误。 备注：调用该函数的用户需要具有SYSADMIN权限。 参数说明： node_name 要查找的复制源的名称 取值范围：字符串，不支持除字母，数字，以及（_?-.）以外的字符。 返回值类型：oid pg_replication_origin_session_setup (node_name) 描述：将当前会话标记为从给定的原点回放，从而允许跟踪回放进度。只能在当前没有选择原点时使用。使用pg_replication_origin_session_reset 命令来撤销。 备注：调用该函数的用户需要具有SYSADMIN权限。 参数说明： node_name 复制源名称。 取值范围：字符串，不支持除字母，数字，以及（_?-.）以外的字符。 pg_replication_origin_session_reset () 描述：取消pg_replication_origin_session_setup()的效果。 备注：调用该函数的用户需要具有SYSADMIN权限。 pg_replication_origin_session_is_setup () 描述：如果在当前会话中选择了复制源则返回真。 备注：调用该函数的用户需要具有SYSADMIN权限。 返回值类型：boolean pg_replication_origin_session_progress (flush) 描述：返回当前会话中选择的复制源的重放位置。 备注：调用该函数的用户需要具有SYSADMIN权限。 参数说明： flush 决定对应的本地事务是否被确保已经刷入磁盘。 取值范围：boolean 返回值类型：LSN pg_replication_origin_xact_setup (origin_lsn, origin_timestamp) 描述：将当前事务标记为重放在给定LSN和时间戳上提交的事务。只能在使用pg_replication_origin_session_setup选择复制源时调用。 备注：调用该函数的用户需要具有SYSADMIN权限。 参数说明： origin_lsn 复制源回放位置。 取值范围：LSN origin_timestamp 事务提交时间。 取值范围：timestamp with time zone pg_replication_origin_xact_reset () 描述：取消pg_replication_origin_xact_setup()的效果。 备注：调用该函数的用户需要具有SYSADMIN权限。 pg_replication_origin_advance (node_name, lsn) 描述： 将给定节点的复制进度设置为给定的位置。这主要用于设置初始位置，或在配置更改或类似的变更后设置新位置。 注意：这个函数的使用不当可能会导致不一致的复制数据。 备注：调用该函数的用户需要具有SYSADMIN权限。 参数说明： node_name 已有复制源名称。 取值范围：字符串，不支持除字母，数字，以及（_?-.）以外的字符。 lsn 复制源回放位置。 取值范围：LSN pg_replication_origin_progress (node_name, flush) 描述：返回给定复制源的重放位置。 备注：调用该函数的用户需要具有SYSADMIN权限。 参数说明： node_name 复制源名称。 取值范围：字符串，不支持除字母，数字，以及（_?-.）以外的字符。 flush 决定对应的本地事务是否被确保已经刷入磁盘。 取值范围：boolean pg_show_replication_origin_status() 描述：获取复制源的复制状态。 备注：调用该函数的用户需要具有SYSADMIN权限。 返回值类型： local_id：oid，复制源id。 external_id：text，复制源名称。 remote_lsn：LSN，复制源的lsn位置。 local_lsn：LSN，本地的lsn位置。 pg_get_publication_tables(pub_name) 描述：根据发布的名称，返回对应发布要发布的表的relid列表 参数说明： pub_name 已存在的发布名称 取值范围：字符串，不支持除字母，数字，以及（_?-.）以外的字符。 返回值类型：relid列表 pg_stat_get_subscription(sub_oid oid) → record 描述： 输入订阅的oid，返回订阅的状态信息。 参数说明： subid 订阅的oid。 取值范围：oid 返回值类型： relid：oid，表的oid。 pid：thread_id，后台apply/sync线程的thread id。 received_lsn：pg_lsn，从发布端接收到的最近的lsn。 last_msg_send_time：timestamp，最近发布端发送消息的时间。 last_msg_receipt_time：timestamp，最新订阅端收到消息的时间。 latest_end_lsn：pg_lsn，最近一次收到保活消息时发布端的lsn。 latest_end_time：timstamp，最近一次收到保活消息的时间。 父主题： 系统管理函数

数据库对象位置函数 pg_relation_filenode(relation regclass) 描述：指定关系的文件节点数。 返回值类型：oid 备注：pg_relation_filenode接受一个表、索引、序列或压缩表的OID或者名称，并且返回当前分配给它的"filenode"数。文件节点是关系使用的文件名称的基本组件。对大多数表来说，结果和pg_class.relfilenode相同，但对确定的系统目录来说， relfilenode为0而且这个函数必须用来获取正确的值。如果传递一个没有存储的关系，比如一个视图，那么这个函数返回NULL。 pg_relation_filepath(relation regclass) 描述：指定关系的文件路径名。 返回值类型：text 备注：pg_relation_filepath类似于pg_relation_filenode，但是它返回关系的整个文件路径名（相对于数据库集群的数据目录PGDATA）。 get_large_table_name(relfile_node text, threshold_size_gb int8) 描述：根据表的文件编码（relfile_node）查询对应的表大小（单位为GB）是否超过阈值（threshold_size_gb），如果超过则返回模式名和表名（形式为schemaname.tablename）， 否则返回字符串’null’。 返回值类型：text pg_filenode_relation(tablespacename, relname) 描述：获取到对应的tablespace和relfilenode所对应的表名。 返回类型：regclass pg_partition_filenode(partition_oid) 描述：获取到指定分区表的oid锁对应的filenode。 返回类型：oid pg_partition_filepath(partition_oid) 描述：指定分区的文件路径名。 返回值类型：text

数据库对象尺寸函数 数据库对象尺寸函数计算数据库对象使用的实际磁盘空间。 pg_column_size(any) 描述：存储一个指定的数值需要的字节数（可能压缩过）。 返回值类型：int 备注：pg_column_size显示用于存储某个独立数据值的空间。 12345 openGauss=# SELECT pg_column_size(1); pg_column_size ---------------- 4(1 row) pg_database_size(oid) 描述：指定OID代表的数据库使用的磁盘空间。 返回值类型：bigint pg_database_size(name) 描述：指定名称的数据库使用的磁盘空间。 返回值类型：bigint 备注：pg_database_size接受一个数据库的OID或者名称，然后返回该对象使用的全部磁盘空间。 示例： 12345 openGauss=# SELECT pg_database_size('postgres'); pg_database_size ------------------ 51590112(1 row) pg_relation_size(oid) 描述：指定OID代表的表或者索引所使用的磁盘空间。 返回值类型：bigint get_db_source_datasize() 描述：估算当前数据库非压缩态的数据总容量 返回值类型：bigint 备注：（1）调用该函数前需要做analyze；（2）通过估算列存的压缩率计算非压缩态的数据总容量。 示例： 1234567 openGauss=# analyze;ANALYZEopenGauss=# select get_db_source_datasize(); get_db_source_datasize------------------------ 35384925667(1 row) pg_relation_size(text) 描述：指定名称的表或者索引使用的磁盘空间。表名称可以用模式名修饰。 返回值类型：bigint pg_relation_size(relation regclass, fork text) 描述：指定表或索引的指定分叉树（'main'，'fsm'或'vm'）使用的磁盘空间。 返回值类型：bigint pg_relation_size(relation regclass) 描述：pg_relation_size(..., 'main')的简写。 返回值类型：bigint 备注：pg_relation_size接受一个表、索引、压缩表的OID或者名称，然后返回它们的字节大小。 pg_partition_size(oid,oid) 描述：指定OID代表的分区使用的磁盘空间。其中，第一个oid为表的OID，第二个oid为分区的OID。 返回值类型：bigint pg_partition_size(text, text) 描述：指定名称的分区使用的磁盘空间。其中，第一个text为表名，第二个text为分区名。 返回值类型：bigint pg_partition_indexes_size(oid,oid) 描述：指定OID代表的分区的索引使用的磁盘空间。其中，第一个oid为表的OID，第二个oid为分区的OID。 返回值类型：bigint pg_partition_indexes_size(text,text) 描述：指定名称的分区的索引使用的磁盘空间。其中，第一个text为表名，第二个text为分区名。 返回值类型：bigint pg_indexes_size(regclass) 描述：附加到指定表的索引使用的总磁盘空间。 返回值类型：bigint pg_size_pretty(bigint) 描述：将以64位整数表示的字节值转换为具有单位的易读格式。 返回值类型：text pg_size_pretty(numeric) 描述：将以数值表示的字节值转换为具有单位的易读格式。 返回值类型：text 备注：pg_size_pretty用于把其他函数的结果格式化成一种易读的格式，可以根据情况使用kB 、MB 、GB 、TB。 pg_table_size(regclass) 描述：指定的表使用的磁盘空间，不计索引（但是包含TOAST，自由空间映射和可见性映射）。 返回值类型：bigint pg_tablespace_size(oid) 描述：指定OID代表的表空间使用的磁盘空间。 返回值类型：bigint pg_tablespace_size(name) 描述：指定名称的表空间使用的磁盘空间。 返回值类型：bigint 备注： pg_tablespace_size接受一个数据库的OID或者名称，然后返回该对象使用的全部磁盘空间。 pg_total_relation_size(oid) 描述：指定OID代表的表使用的磁盘空间，包括索引和压缩数据。 返回值类型：bigint pg_total_relation_size(regclass) 描述：指定的表使用的总磁盘空间，包括所有的索引和TOAST数据。 返回值类型：bigint pg_total_relation_size(text) 描述：指定名称的表所使用的全部磁盘空间，包括索引和压缩数据。表名称可以用模式名修饰。 返回值类型：bigint 备注：pg_total_relation_size接受一个表或者一个压缩表的OID或者名称，然后返回以字节计的数据和所有相关的索引和压缩表的尺寸。 datalength(any) 描述：计算一个指定的数据需要的字节数（不考虑数据的管理空间和数据压缩，数据类型转换等情况）。 返回值类型：int 备注：datalength用于计算某个独立数据值的空间。 示例： openGauss=# SELECT datalength(1);datalength------------4(1 row) 目前支持的数据类型及计算方式见下表： 数据类型 存储空间 数值类型 整数类型 TINYINT 1 SMALLINT 2 INTEGER 4 BINARY_INTEGER 4 BIGINT 8 任意精度型 DECIMAL 每4位十进制数占两个字节，小数点前后数字分别计算 NUMERIC 每4位十进制数占两个字节，小数点前后数字分别计算 NUMBER 每4位十进制数占两个字节，小数点前后数字分别计算 序列整型 SMALLSERIAL 2 SERIAL 4 BIGSERIAL 8 浮点类型 FLOAT4 4 DOUBLE PRECISION 8 FLOAT8 8 BINARY_DOUBLE 8 FLOAT[(p)] 每4位十进制数占两个字节，小数点前后数字分别计算 DEC[(p[,s])] 每4位十进制数占两个字节，小数点前后数字分别计算 INTEGER[(p[,s])] 每4位十进制数占两个字节，小数点前后数字分别计算 布尔类型 布尔类型 BOOLEAN 1 字符类型 字符类型 CHAR n CHAR(n) n CHARACTER(n) n NCHAR(n) n VARCHAR(n) n CHARACTER 字符实际字节数 VARYING(n) 字符实际字节数 VARCHAR2(n) 字符实际字节数 NVARCHAR2(n) 字符实际字节数 TEXT 字符实际字节数 CLOB 字符实际字节数 时间类型 时间类型 DATE 8 TIME 8 TIMEZ 12 TIMESTAMP 8 TIMESTAMPZ 8 SMALLDATETIME 8 INTERVAL DAY TO SECOND 16 INTERVAL 16 RELTIME 4 ABSTIME 4 TINTERVAL 12

恢复控制函数 恢复信息函数提供了当前备机状态的信息。这些函数可能在恢复期间或正常运行中执行。 pg_is_in_recovery() 描述：如果恢复仍然在进行中则返回true。 返回值类型：bool pg_last_xlog_receive_location() 描述：获取最后接收事务日志的位置并通过流复制将其同步到磁盘。当流复制正在进行时，事务日志将持续递增。如果恢复已完成，则最后一次获取的WAL记录会被静态保持并在恢复过程中同步到磁盘。如果流复制不可用，或还没有开始，这个函数返回NULL。 返回值类型：text pg_last_xlog_replay_location() 描述：获取最后一个事务日志在恢复时重放的位置。如果恢复仍在进行，事务日志将持续递增。如果已经完成恢复，则将保持在恢复期间最后接收WAL记录的值。如果未进行恢复但服务器正常启动时，则这个函数返回NULL。 返回值类型：text pg_last_xact_replay_timestamp() 描述：获取最后一个事务在恢复时重放的时间戳。这是为在主节点上生成事务提交或终止WAL记录的时间。如果在恢复时没有事务重放，则这个函数返回NULL。如果恢复仍在进行，则事务日志将持续递增。如果恢复已经完成，则将保持在恢复期间最后接收WAL记录的值。如果服务器无需恢复就已正常启动，则这个函数返回NULL。 返回值类型：timestamp with time zone 恢复控制函数控制恢复的进程。这些函数可能只在恢复时被执行。 pg_is_xlog_replay_paused() 描述：如果恢复暂停则返回true。 返回值类型：bool pg_xlog_replay_pause() 描述：立即暂停恢复。 返回值类型：void pg_xlog_replay_resume() 描述：如果恢复处于暂停状态，则重新启动。 返回值类型：void gs_get_active_archiving_standby() 描述：查询同一分片内归档备机的信息。返回备机名，备机归档位置和已归档日志个数。 返回值类型：text，text，int gs_pitr_get_warning_for_xlog_force_recycle() 描述：查询开启归档后是否因归档槽不推进日志大量堆积导致日志被回收。 返回值类型：bool gs_pitr_clean_history_global_barriers(stop_barrier_timestamp cstring) 描述：清理指定时间之前所有barrier记录。返回最老的barrier记录。入参为cstring类型，linux时间戳。需要管理员角色或运维管理员角色执行。 返回值类型：text gs_pitr_archive_slot_force_advance(stop_barrier_timestamp cstring) 描述：强制推进归档槽，并清理不需要的barrier记录。返回新的归档槽位置。入参为cstring类型，linux时间戳。需要管理员角色或运维管理员角色执行。 返回值类型：text 当恢复暂停时，没有发生数据库更改。如果是在热备里，所有新的查询将看到一致的数据库快照，并且不会有进一步的查询冲突产生，直到恢复继续。 如果不能使用流复制，则暂停状态将无限的延续。当流复制正在进行时，将连续接收WAL记录，最终将填满可用磁盘空间，这个进度取决于暂停的持续时间，WAL生成的速度和可用的磁盘空间。

备份控制函数 备份控制函数可帮助进行在线备份。 pg_create_restore_point(name text) 描述：为执行恢复创建一个命名点。（需要管理员角色） 返回值类型：text 备注：pg_create_restore_point创建了一个可以用作恢复目的、有命名的事务日志记录，并返回相应的事务日志位置。在恢复过程中，recovery_target_name可以通过这个名称定位对应的日志恢复点，并从此处开始执行恢复操作。避免使用相同的名称创建多个恢复点，因为恢复操作将在第一个匹配（恢复目标）的名称上停止。 pg_current_xlog_location() 描述：获取当前事务日志的写入位置。 返回值类型：text 备注：pg_current_xlog_location使用与前面那些函数相同的格式显示当前事务日志的写入位置。如果是只读操作，不需要系统管理员权限。 pg_current_xlog_insert_location() 描述：获取当前事务日志的插入位置。 返回值类型：text 备注：pg_current_xlog_insert_location显示当前事务日志的插入位置。插入点是事务日志在某个瞬间的“逻辑终点”，而实际的写入位置则是从服务器内部缓冲区写出时的终点。写入位置是可以从服务器外部检测到的终点，如果要归档部分完成事务日志文件，则该操作即可实现。插入点主要用于服务器调试目的。如果是只读操作，不需要系统管理员权限。 gs_current_xlog_insert_end_location() 描述：获取当前事务日志的插入位置。 返回值类型：text 备注：gs_current_xlog_insert_end_location显示当前事务日志的实际插入位置。 pg_start_backup(label text, is_full_backup boolean) 描述：开始执行在线备份（需要管理员角色、复制的角色或运维管理员角色打开operate_mode）。以gs_roach开头的label串为保留命名串，只能由内部备份工具GaussRoach使用。 返回值类型：text 备注：pg_start_backup接受一个用户定义的备份标签（通常这是备份转储文件存放地点的名称）。这个函数向数据库集群的数据目录写入一个备份标签文件，然后以文本方式返回备份的事务日志起始位置。 12345 openGauss=# SELECT pg_start_backup('label_goes_here',true); pg_start_backup----------------- 0/3000020(1 row) pg_stop_backup() 描述：完成执行在线备份。需要管理员角色或复制的角色执行。 返回值类型：text 备注：pg_stop_backup删除pg_start_backup创建的标签文件，并且在事务日志归档区里创建一个备份历史文件。这个历史文件包含给予pg_start_backup的标签、备份的事务日志起始与终止位置、备份的起始和终止时间。返回值是备份的事务日志终止位置。计算出中止位置后，当前事务日志的插入点将自动前进到下一个事务日志文件，这样，结束的事务日志文件可以被立即归档从而完成备份。 pg_switch_xlog() 描述：切换到一个新的事务日志文件。需要管理员角色或运维管理员角色打开operation_mode。 返回值类型：text 备注：pg_switch_xlog移动到下一个事务日志文件，以允许将当前日志文件归档（假定使用连续归档）。返回值是刚完成的事务日志文件的事务日志结束位置+1。如果从最后一次事务日志切换以来没有活动的事务日志，则pg_switch_xlog什么事也不做，直接返回当前事务日志文件的开始位置。 pg_xlogfile_name(location text) 描述：将事务日志的位置字符串转换为文件名。 返回值类型：text 备注：pg_xlogfile_name仅抽取事务日志文件名称。如果给定的事务日志位置恰好位于事务日志文件的交界上，这两个函数都返回前一个事务日志文件的名称。这对于管理事务日志归档来说是非常有利的，因为前一个文件是当前最后一个需要归档的文件。 pg_xlogfile_name_offset(location text) 描述：将事务日志的位置字符串转换为文件名并返回在文件中的字节偏移量。 返回值类型：text,integer 备注：可以使用pg_xlogfile_name_offset从前述函数的返回结果中抽取相应的事务日志文件名称和字节偏移量。例如： 1234567 openGauss=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());NOTICE: pg_stop_backup cleanup done, waiting for required WAL segments to be archivedNOTICE: pg_stop_backup complete, all required WAL segments have been archived file_name | file_offset --------------------------+-------------000000010000000000000003 | 272(1 row) pg_xlog_location_diff(location text, location text) 描述：计算两个事务日志位置之间在字节上的区别。 返回值类型：numeric pg_cbm_tracked_location() 描述：用于查询cbm解析到的lsn位置。 返回值类型：text pg_cbm_get_merged_file(startLSNArg text, endLSNArg text) 描述：用于将指定lsn范围之内的cbm文件合并成一个cbm文件，并返回合并完的cbm文件名。 返回值类型：text 备注：必须是系统管理员或运维管理员才能获取cbm合并文件。 pg_cbm_get_changed_block(startLSNArg text, endLSNArg text) 描述：用于将指定lsn范围之内的cbm文件合并成一个表，并返回表的各行记录。 返回值类型：records 备注：pg_cbm_get_changed_block返回的表字段包含：合并起始的lsn，合并截止的lsn，表空间oid，库oid，表的relfilenode，表的fork number，表是否被删除，表是否被创建，表是否被截断，表被截断后的页面数，有多少页被修改以及被修改的页号的列表。 pg_cbm_recycle_file(targetLSNArg text) 描述：删除不再使用的cbm文件，并返回删除后的第一条lsn。 返回值类型：text pg_cbm_force_track(targetLSNArg text,timeOut int) 描述：强制执行一次cbm追踪到指定的xlog位置，并返回实际追踪结束点的xlog位置。 返回值类型：text pg_enable_delay_ddl_recycle() 描述：开启延迟DDL功能，并返回开启点的xlog位置。需要管理员角色或运维管理员角色打开operation_mode。 返回值类型：text pg_disable_delay_ddl_recycle(barrierLSNArg text, isForce bool) 描述：关闭延迟DDL功能，并返回本次延迟DDL生效的xlog范围。需要管理员角色或运维管理员角色打开operation_mode。 返回值类型：records pg_enable_delay_xlog_recycle() 描述：开启延迟xlog回收功能，cn修复使用。需要管理员角色或运维管理员角色打开operation_mode。 返回值类型：void pg_disable_delay_xlog_recycle() 描述：关闭延迟xlog回收功能，cn修复使用。需要管理员角色或运维管理员角色打开operation_mode。 返回值类型：void pg_cbm_rotate_file(rotate_lsn text) 描述：等待cbm解析到rotate_lsn之后，强制切换文件，在build期间调用。 返回值类型：void。 gs_roach_stop_backup(backupid text) 描述：停止一个内部备份工具GaussRoach开启的备份。与pg_stop_backup系统函数类似，但更轻量。 返回值类型：text，内容为当前日志的插入位置。 gs_roach_enable_delay_ddl_recycle(backupid name) 描述：开启延迟DDL功能，并返回开启点的日志位置。与pg_enable_delay_ddl_recycle系统函数类似，但更轻量。并且，通过传入不同的backupid，可以支持并发打开延迟DDL。 返回值类型：text，内容为返回开启点的日志位置。 gs_roach_disable_delay_ddl_recycle(backupid text) 描述：关闭延迟DDL功能，并返回本次延迟DDL生效的日志范围，并删除该范围内被用户删除的列存表物理文件。与pg_enable_delay_ddl_recycle系统函数类似，但更轻量。并且，通过传入不同的backupid，可以支持并发关闭延迟DDL功能。 返回值类型：records，内容为本次延迟DDL生效的日志范围。 gs_roach_switch_xlog(request_ckpt bool) 描述：切换当前使用的日志段文件，并且，如果request_ckpt 为true，则触发一个全量检查点。 返回值类型：text，内容为切段日志的位置。 gs_block_dw_io(timeout int, identifier text) 描述：阻塞双写页面刷盘。 参数说明： timeout 阻塞时长。 取值范围：[0, 3600]（秒），0为阻塞时长为0。 identifier 此次操作的标识。 取值范围：字符串，不支持除大小写字母，数字，以及下划线(_)以外的字符。 返回值类型：bool 备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operate_mode。 gs_is_dw_io_blocked() 描述：查看当前双写页面刷盘是否被阻塞，如果处于阻塞中则返回true。 返回值类型：bool 备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operate_mode。

双集群容灾查询函数 gs_get_global_barrier_status() 描述：两地三中心跨Region容灾特性开启后，主集群和灾备集群通过obs进行日志同步，通过barrier日志在主集群的落盘，在灾备集群的回放来确定主集群归档日志进度与灾备集群日志回放进度。gs_get_global_barrier_status用以查询主集群已在obs完成归档的最新global barrier。 返回值类型：text global_barrier_id：全局最新barrier ID global_achive_barrier_id：全局最新归档barrier ID gs_get_local_barrier_status() 描述：两地三中心跨Region容灾特性开启后，主集群和灾备集群通过obs进行日志同步，通过barrier日志在主集群的落盘，在灾备集群的回放来确定主集群归档日志进度与灾备集群日志回放进度。gs_get_local_barrier_status用于查询灾备集群每个节点当前的日志回放情况。 返回值类型：text barrier_id：灾备集群某节点当前回放到的最新barrier ID barrier_lsn：灾备集群某节点当前回放到的最新barrier ID的Log Sequence Number ( LSN ) archive_lsn：灾备集群某节点当前已获得归档日志的位置，该参数当前未生效。 flush_lsn：灾备集群某节点当前已完成刷盘日志位置。 gs_get_global_barriers_status() 描述：两地三中心跨Region容灾特性-基于OBS的解决方案开启后，主数据库实例和多个灾备数据库实例通过obs进行日志同步，通过barrier日志在主数据库实例的落盘，在灾备数据库实例的回放来确定主数据库实例归档日志进度与灾备数据库实例日志回放进度。gs_get_global_barriers_status用以查询主数据库实例已在obs完成归档的最新global barrier。 返回值类型：text slot_name：容灾使用的槽位名。 global_barrier_id：全局最新barrier ID。 global_achive_barrier_id：全局最新归档barrier ID。 gs_upload_obs_file('slot_name', 'src_file', 'dest_file') 描述：两地三中心跨Region容灾特性开启后，主集群上传数据到OBS上的函数。 返回值类型：void slot_name：主集群CN创建的复制槽的名字。 src_file：主集群CN数据目录下的需要上传的文件的文件位置。 dest_file：上传到OBS上对应的文件的文件位置。 gs_download_obs_file('slot_name', 'src_file', 'dest_file') 描述：两地三中心跨Region容灾特性开启后，灾备集群从OBS上下载数据到本地的函数。 返回值类型：void slot_name：灾备集群CN创建的复制槽的名字。 src_file：OBS需要下载的文件的文件位置。 dest_file：灾备集群CN数据目录下需要存放下载文件对应的文件位置。 gs_get_obs_file_context('file_name', 'slot_name') 描述：两地三中心跨Region容灾特性开启后，查询OBS上对应文件的内容。 返回值类型：text file_name：OBS上文件的文件名。 slot_name：主/灾备集群CN创建的复制槽的名字。 gs_set_obs_file_context('file_name', 'file_context','slot_name') 描述：两地三中心跨Region容灾特性开启后，在OBS上创建文件并写入对应的内容。 返回值类型：text file_name：OBS上文件的文件名。 file_context： 写入文件的内容。 slot_name：主/灾备集群CN创建的复制槽的名字。 gs_get_hadr_key_cn() 描述：两地三中心跨Region容灾特性开启后，在OBS上创建文件并写入对应的内容。 返回值类型：text file_name：OBS上文件的文件名。 file_context： 写入文件的内容。 slot_name：主/灾备集群CN创建的复制槽的名字。 gs_hadr_has_barrier_creator() 描述：两地三中心跨Region容灾特性开启后，查询当前cn节点是否存在barrier_creator线程，存在返回true（需要系统管理员角色）。 返回值类型：Boolean 备注：该函数只有在容灾集群启动计划内switchover时使用。 gs_hadr_in_recovery() 描述：两地三中心跨Region容灾特性开启后，查询当前节点是否处于基于目标barrier的日志恢复中，还在恢复中返回true。只有完成日志恢复，才会启动switchover流程中的灾备集群升为生产集群的步骤，需要系统管理员角色执行。 返回值类型：Boolean 该函数只有在容灾集群启动计划内switchover时使用。 gs_streaming_dr_get_switchover_barrier() 描述：两地三中心跨Region容灾-基于流式复制的解决方案中，查询灾备集群参与容灾的CN与首备DN实例是否已接收到switchover barrier日志并完成回放，已完成返回true。灾备集群只有在所有DN实例都完成switchover barrier日志回放，才会启动switchover流程中的灾备数据库实例升为生产数据库实例的步骤（需要系统管理员角色）。 返回值类型：Boolean 备注：该函数只有在流式容灾解决方案中容灾数据库实例启动计划内switchover时使用。 gs_streaming_dr_service_truncation_check() 描述：两地三中心跨Region容灾-基于流式复制的解决方案中，查询主集群参与容灾的CN与主DN实例是否已完成switchover barrier日志发送，已完成返回true。只有完成日志发送，才会启动switchover流程中的生产数据库实例降为灾备数据库实例的步骤（需要系统管理员角色）。 返回值类型：Boolean 备注：该函数只有在容灾数据库实例启动计划内switchover时使用。 gs_hadr_local_rto_and_rpo_stat() 描述：显示流式容灾的本地节点数据库实例和灾备数据库实例日志流控信息（如果在没有参加流式容灾的节点执行，如备DN或部分CN节点，则可能返回空）。 返回值类型：record，具体各个字段的类型和含义如下： 参数 类型 描述 hadr_sender_node_name text 节点的名称，包含主数据库实例和备数据库实例首备。 hadr_receiver_node_name text 备数据库实例首备名称。 source_ip text 主数据库实例主DN IP地址。 source_port int 主数据库实例主DN通信端口。 dest_ip text 备数据库实例首备DN IP地址。 dest_port int 备数据库实例首备DN通信端口。 current_rto int 流控的信息，当前主备数据库实例的日志rto时间（单位：秒）。 target_rto int 流控的信息，目标主备数据库实例间的rto时间（单位：秒）。 current_rpo int 流控的信息，当前主备数据库实例的日志rpo时间（单位：秒）。 target_rpo int 流控的信息，目标主备数据库实例间的rpo时间（单位：秒）。 rto_sleep_time int RTO流控信息，为了达到目标rto，预期主机walsender所需要的睡眠时间（单位：微秒）。 rpo_sleep_time int RPO流控信息，为了达到目标rpo，预期主机xlogInsert所需要的睡眠时间（单位：微秒）。 gs_hadr_remote_rto_and_rpo_stat() 描述：显示流式容灾的其他所有分片或CN数据库实例和灾备数据库实例日志流控信息（一般在CN节点执行；如果在DN节点执行，可能返回为空）。 返回值类型：record，具体各个字段的类型和含义如下： 参数 类型 描述 hadr_sender_node_name text 节点的名称，包含主数据库实例和备数据库实例首备。 hadr_receiver_node_name text 备数据库实例首备名称。 source_ip text 主数据库实例主DN IP地址。 source_port int 主数据库实例主DN通信端口。 dest_ip text 备数据库实例首备DN IP地址。 dest_port int 备数据库实例首备DN通信端口。 current_rto int 流控的信息，当前主备数据库实例的日志rto时间（单位：秒）。 target_rto int 流控的信息，目标主备数据库实例间的rto时间（单位：秒）。 current_rpo int 流控的信息，当前主备数据库实例的日志rpo时间（单位：秒）。 target_rpo int 流控的信息，目标主备数据库实例间的rpo时间（单位：秒）。 rto_sleep_time int RTO流控信息，为了达到目标rto，预期主机walsender所需要的睡眠时间（单位：微秒）。 rpo_sleep_time int RPO流控信息，为了达到目标rpo，预期主机xlogInsert所需要的睡眠时间（单位：微秒）。 父主题： 系统管理函数

咨询锁函数 咨询锁函数用于管理咨询锁（Advisory Lock）。 pg_advisory_lock(key bigint) 描述：获取会话级别的排它咨询锁。 返回值类型：void 备注：pg_advisory_lock锁定应用程序定义的资源，该资源可以用一个64位或两个不重叠的32位键值标识。如果已经有另外的会话锁定了该资源，则该函数将阻塞到该资源可用为止。这个锁是排它的。多个锁定请求将会被压入栈中，因此，如果同一个资源被锁定了三次，它必须被解锁三次以将资源释放给其他会话使用。 pg_advisory_lock(key1 int, key2 int) 描述：获取会话级别的排它咨询锁。 返回值类型：void 备注：只允许sysadmin对键值对(65535, 65535)加会话级别的排它咨询锁，普通用户无权限。 pg_advisory_lock(int4, int4, Name) 描述：获取指定数据库的排它咨询锁。 返回值类型：void pg_advisory_lock_shared(key bigint) 描述：获取会话级别的共享咨询锁。 返回值类型：void pg_advisory_lock_shared(key1 int, key2 int) 描述：获取会话级别的共享咨询锁。 返回值类型：void 备注：pg_advisory_lock_shared类似于pg_advisory_lock，不同之处仅在于共享锁会话可以和其他请求共享锁的会话共享资源，但排它锁除外。 pg_advisory_unlock(key bigint) 描述：释放会话级别的排它咨询锁。 返回值类型：Boolean pg_advisory_unlock(key1 int, key2 int) 描述：释放会话级别的排它咨询锁。 返回值类型：Boolean 备注：pg_advisory_unlock释放先前取得的排它咨询锁。如果释放成功则返回true。如果实际上并未持有指定的锁，将返回false并在服务器中产生一条SQL警告信息。 pg_advisory_unlock(int4, int4, Name) 描述：释放指定数据库上的排它咨询锁。 返回值类型：Boolean 备注：如果释放成功则返回true；如果未持有锁，则返回false。 pg_advisory_unlock_shared(key bigint) 描述：释放会话级别的共享咨询锁。 返回值类型：Boolean pg_advisory_unlock_shared(key1 int, key2 int) 描述：释放会话级别的共享咨询锁。 返回值类型：Boolean 备注：pg_advisory_unlock_shared类似于pg_advisory_unlock，不同之处在于该函数释放的是共享咨询锁。 pg_advisory_unlock_all() 描述：释放当前会话持有的所有咨询锁。 返回值类型：void 备注：pg_advisory_unlock_all将会释放当前会话持有的所有咨询锁，该函数在会话结束的时候被隐含调用，即使客户端异常地断开连接也是一样。 pg_advisory_xact_lock(key bigint) 描述：获取事务级别的排它咨询锁。 返回值类型：void pg_advisory_xact_lock(key1 int, key2 int) 描述：获取事务级别的排它咨询锁。 返回值类型：void 备注：pg_advisory_xact_lock类似于pg_advisory_lock，不同之处在于锁是自动在当前事务结束时释放，而且不能被显式的释放。只允许sysadmin对键值对(65535, 65535)加事务级别的排它咨询锁，普通用户无权限。 pg_advisory_xact_lock_shared(key bigint) 描述：获取事务级别的共享咨询锁。 返回值类型：void pg_advisory_xact_lock_shared(key1 int, key2 int) 描述：获取事务级别的共享咨询锁。 返回值类型：void 备注：pg_advisory_xact_lock_shared类似于pg_advisory_lock_shared，不同之处在于锁是在当前事务结束时自动释放，而且不能被显式的释放。 pg_try_advisory_lock(key bigint) 描述：尝试获取会话级排它咨询锁。 返回值类型：Boolean 备注：pg_try_advisory_lock类似于pg_advisory_lock，不同之处在于该函数不会阻塞以等待资源的释放。它要么立即获得锁并返回true，要么返回false表示目前不能锁定。 pg_try_advisory_lock(key1 int, key2 int) 描述：尝试获取会话级排它咨询锁。 返回值类型：Boolean 备注：只允许sysadmin对键值对(65535, 65535)加会话级别的排它咨询锁，普通用户无权限。 pg_try_advisory_lock_shared(key bigint) 描述：尝试获取会话级共享咨询锁。 返回值类型：Boolean pg_try_advisory_lock_shared(key1 int, key2 int) 描述：尝试获取会话级共享咨询锁。 返回值类型：Boolean 备注：pg_try_advisory_lock_shared类似于pg_try_advisory_lock，不同之处在于该函数尝试获得共享锁而不是排它锁。 pg_try_advisory_xact_lock(key bigint) 描述：尝试获取事务级别的排它咨询锁。 返回值类型：Boolean pg_try_advisory_xact_lock(key1 int, key2 int) 描述：尝试获取事务级别的排它咨询锁。 返回值类型：Boolean 备注：pg_try_advisory_xact_lock类似于pg_try_advisory_lock，不同之处在于如果得到锁，在当前事务的结束时自动释放，而且不能被显式的释放。只允许sysadmin对键值对(65535, 65535)加事务级别的排它咨询锁，普通用户无权限。 pg_try_advisory_xact_lock_shared(key bigint) 描述：尝试获取事务级别的共享咨询锁。 返回值类型：Boolean pg_try_advisory_xact_lock_shared(key1 int, key2 int) 描述：尝试获取事务级别的共享咨询锁。 返回值类型：Boolean 备注：pg_try_advisory_xact_lock_shared类似于pg_try_advisory_lock_shared，不同之处在于如果得到锁，在当前事务结束时自动释放，而且不能被显式的释放。 lock_cluster_ddl() 描述：尝试对集群内所有存活的CN节点获取会话级别的排他咨询锁。 返回值类型：Boolean 备注：只允许sysadmin调用，普通用户无权限。 unlock_cluster_ddl() 描述：尝试对CN节点会话级别的排他咨询锁。 返回值类型：Boolean 父主题： 系统管理函数

双集群容灾控制函数 双集群容灾控制函数可以创建归档槽，归档槽指定了保存物理日志的obs信息。 pg_create_physical_replication_slot_extern(slotname text, dummy_standby bool, extra_content text, need_recycle_xlog bool) 描述：创建OBS/NAS归档槽。slotname 为本次灾备的slotname ，主备必须使用同一个slotname 。dummy_standby标志是主备从还是一主多备，false表示一主多备，true表示主备从。extra_content包含了归档槽的一些信息。对于OBS归档槽，其格式为"OBS;obs_server_ip;obs_bucket_name;obs_ak;obs_sk;archive_path;is_recovery;is_vote_replicate"，OBS表示归档槽的归档的介质，obs_server_ip为obs的ip，obs_bucket_name为obs的桶名，obs_ak为obs的ak，obs_sk为obs的sk，archive_path为归档的路径i，is_recovery标志是归档槽还是恢复槽，0表示是归档槽，主要是主集群使用；1表示是恢复槽，主要是灾备集群使用。is_vote_replicate标志是否是投票副本优先，0表示同步备机归档优先，1表示投票副本归档优先，当前版本该字段为预留字段，暂未适配。对于NAS归档槽，其格式为"NAS;archive_path;is_recovery;is_vote_replicate"，相比OBS归档槽，缺少了OBS相关的配置信息，其余字段意义相同。 如果是不指定OBS或NAS介质的话，默认指定的是OBS归档槽，其extra_content格式为"obs_server_ip;obs_bucket_name;obs_ak;obs_sk;archive_path;is_recovery;is_vote_replicate"。 need_recycle_xlog标志创建归档槽时是否回收老的归档日志，true表示回收，false表示不回收。 返回值类型：records包含本次灾备的slotname和xlog_position 备注：调用该函数的用户需要具有SYSADMIN权限或具有REPLICATION权限或继承了内置角色gs_role_replication的权限。 例如： 创建OBS归档槽： 12345 openGauss=# select * from pg_create_physical_replication_slot_extern('uuid', false, 'OBS;obs.cn-north-7.ulanqab.huawei.com;dyk;19D772JBCACXX3KWS51D;********;openGauss_uuid/dn1;0;0', false); slotname | xlog_position----------+--------------- uuid |(1 row) 创建NAS归档槽： 1234 openGauss=# select * from pg_create_physical_replication_slot_extern('uuid', false, 'NAS;/data/nas/media/openGauss_uuid/dn1;0;0', false); slotname | xlog_position----------+--------------- uuid | gs_set_obs_delete_location(delete_location text) 描述：设置obs归档日志可删除的位置。delete_location实际为Log Sequence Number ( LSN )，该位置之前的日志在灾备集群已经完成回放并且落盘，可以在obs上进行删除。 返回值类型：xlog_file_name text，表明此次可删除点所在的日志文件名。无论obs删除是否成功，该值都会正常返回。 openGauss=# select gs_set_obs_delete_location('0/54000000'); gs_set_obs_delete_location ----------------------------- 000000010000000000000054_00(1 row) gs_hadr_do_switchover() 描述：异地容灾集群中主集群在执行计划内swithover过程中截断业务的接口。 返回值类型：bool，表明此次业务截断是否成功，是否可以正常进行switchover流程。 gs_set_obs_delete_location_with_slotname(cstring, cstring ) 描述：设置某个容灾关系上obs归档日志可删除的位置。第一个参数实际为Log Sequence Number ( LSN )，该位置之前的日志在灾备数据库实例已经完成回放并且落盘，可以在obs上进行删除，第二个参数为归档槽的名称。 返回值类型：xlog_file_name text，表明此次可删除点所在的日志文件名。无论obs删除是否成功，该值都会正常返回。 gs_streaming_dr_in_switchover() 描述：基于流式复制的异地容灾解决方案中主集群在执行计划内swithover过程中截断业务的接口。 返回值类型：bool，表明此次业务截断是否成功，是否可以正常进行switchover流程。 父主题： 系统管理函数

服务器信号函数 服务器信号函数向其他服务器进程发送控制信号。仅系统管理员有权执行以下函数。 pg_cancel_backend(pid int) 描述：取消一个后端的当前查询。 返回值类型：Boolean 备注：pg_cancel_backend向由pid标识的后端进程发送一个查询取消（SIGINT）信号。一个活动的后端进程的PID可以从pg_stat_activity视图的pid字段找到，或者在服务器上用ps列出数据库进程。具有SYSADMIN权限的用户，后端进程所连接的数据库的属主，后端进程的属主或者继承了内置角色gs_role_signal_backend权限的用户有权使用该函数。 pg_cancel_session(pid bigint, sessionid bigint) 描述：取消一个后台会话。 返回值类型：Boolean 备注：pg_cancel_session的入参可以通过pg_stat_activity中的pid字段和sessionid的字段查询，可以用于清理线程池模式下，非活跃状态的会话。 pg_cancel_invalid_query() 描述：取消一个后端的无效查询。 返回值类型：Boolean 备注：只有系统管理员才有权限取消连接到降级的GTM的后端中运行的查询。 pg_reload_conf() 描述：导致所有服务器进程重新装载它们的配置文件。 返回值类型：Boolean 备注：pg_reload_conf给服务器发送一个SIGHUP信号，导致所有服务器进程重新装载配置文件。 pg_rotate_logfile() 描述：滚动服务器的日志文件。 返回值类型：Boolean 备注：pg_rotate_logfile给日志文件管理器发送信号，告诉它立即切换到一个新的输出文件。这个函数只有在redirect_stderr用于日志输出的时候才有用，否则根本不存在日志文件管理器子进程。 pg_terminate_session(pid bigint, sessionid bigint) 描述：终止一个后台会话。 返回值类型：Boolean 备注：本函数的入参可以通过pg_stat_activity中的pid字段和sessionid的字段查询。可以用于清理线程池模式下，非活跃状态的会话。具有SYSADMIN权限的用户，会话所连接的数据库的属主，会话的属主或者继承了内置角色gs_role_signal_backend权限的用户有权使用该函数。 pg_terminate_backend(pid int) 描述：终止一个后台线程。仅系统管理员和线程所有者可执行该函数。 返回值类型：Boolean 备注：如果成功，函数返回true，否则返回false。具有SYSADMIN权限的用户，后端线程所连接的数据库的属主，后端线程的属主或者继承了内置角色gs_role_signal_backend权限的用户有权使用该函数。 示例： 1 2 3 4 5 6 7 8 91011 openGauss=# SELECT pid from pg_stat_activity; pid ----------------- 140657876268816(1 rows)openGauss=# SELECT pg_terminate_backend(140657876268816); pg_terminate_backend ---------------------- t(1 row) 父主题： 系统管理函数

快照同步函数 快照同步函数是导出当前快照的标识符。 pg_export_snapshot() 描述：保存当前的快照并返回它的标识符。 返回值类型：text 备注：函数pg_export_snapshot保存当前的快照并返回一个文本字符串标识此快照。这个字符串必须传递给想要导入快照的客户端。可用在set transaction snapshot snapshot_id时导入snapshot，但是应用的前提是该事务设置了SERIALIZABLE或REPEATABLE READ隔离级别。而GaussDB目前是不支持这两种隔离级别的。该函数的输出不可用做set transaction snapshot的输入。 pg_export_snapshot_and_csn() 描述：保存当前的快照并返回它的标识符。比pg_export_snapshot()多返回一列CSN，表示当前快照的CSN。 返回值类型：text 父主题： 系统管理函数

通用文件访问函数 通用文件访问函数提供了对数据库服务器上的文件的本地访问接口。只有数据库集群目录和log_directory目录里面的文件可以访问。使用相对路径访问集群目录里面的文件，以及匹配log_directory配置而设置的路径访问日志文件。只有数据库初始化用户才能使用这些函数。 pg_ls_dir(dirname text) 描述：列出目录中的文件。 返回值类型：setof text 备注：pg_ls_dir返回指定目录里面的除了特殊项“.”和“..”之外所有名称。 示例： 1 2 3 4 5 6 7 8 9101112131415161718192021222324252627282930313233343536 openGauss=# SELECT pg_ls_dir('./'); pg_ls_dir ---------------------- .postgresql.conf.swp postgresql.conf pg_tblspc PG_VERSION pg_ident.conf core server.crt pg_serial pg_twophase postgresql.conf.lock pg_stat_tmp pg_notify pg_subtrans pg_ctl.lock pg_xlog pg_clog base pg_snapshots postmaster.opts postmaster.pid server.key.rand server.key.cipher pg_multixact pg_errorinfo server.key pg_hba.conf pg_replslot .pg_hba.conf.swp cacert.pem pg_hba.conf.lock global gaussdb.state(32 rows) pg_read_file(filename text, offset bigint, length bigint) 描述：返回一个文本文件的内容。 返回值类型：text 备注：pg_read_file返回一个文本文件的一部分，从offset开始，最多返回length字节（如果先达到文件结尾，则小于这个数值）。如果offset是负数，则它是相对于文件结尾回退的长度。如果省略了offset和length，则返回整个文件。仅数据库初始化用户可执行该函数。 示例： 1 2 3 4 5 6 7 8 91011 openGauss=# SELECT pg_read_file('postmaster.pid',0,100); pg_read_file --------------------------------------- 53078 + /srv/BigData/testdir/data1/coordinator+ 1500022474 + 8000 + /var/run/FusionInsight + localhost + 2(1 row) pg_read_binary_file(filename text [, offset bigint, length bigint,missing_ok boolean]) 描述：返回一个二进制文件的内容，只有初始用户有权限调用。 返回值类型：bytea 备注：pg_read_binary_file的功能与pg_read_file类似，除了结果的返回值为bytea类型不一致，相应地不会执行编码检查。与convert_from函数结合，这个函数可以用来读取用指定编码的一个文件。 1 openGauss=# SELECT convert_from(pg_read_binary_file('filename'), 'UTF8'); pg_stat_file(filename text) 描述：返回一个文本文件的状态信息。 返回值类型：record 备注：pg_stat_file返回一条记录，其中包含：文件大小、最后访问时间戳、最后更改时间戳、最后文件状态修改时间戳以及标识传入参数是否为目录的Boolean值。典型的用法： 1 openGauss=# SELECT * FROM pg_stat_file('filename'); 1 openGauss=# SELECT (pg_stat_file('filename')).modification; 示例： 1 2 3 4 5 6 7 8 9101112 openGauss=# SELECT convert_from(pg_read_binary_file('postmaster.pid'), 'UTF8'); convert_from -------------------------------------- 4881 + /srv/BigData/gaussdb/data1/coordinator+ 1496308688 + 25108 + /opt/huawei/Bigdata/gaussdb/gaussdb_tmp + * + 25108001 43352069 +(1 row) 123456789 openGauss=# SELECT * FROM pg_stat_file('postmaster.pid'); size | access | modification | change | creation | isdir ------+------------------------+------------------------+------------------------+----------+------- 117 | 2017-06-05 11:06:34+08 | 2017-06-01 17:18:08+08 | 2017-06-01 17:18:08+08 | | f(1 row) 12345 openGauss=# SELECT (pg_stat_file('postmaster.pid')).modification; modification ------------------------ 2017-06-01 17:18:08+08(1 row) 父主题： 系统管理函数

配置设置函数 配置设置函数是可以用于查询以及修改运行时配置参数的函数。 current_setting(setting_name) 描述：当前的设置值。 返回值类型：text 备注：current_setting用于以查询形式获取setting_name的当前值。和SQL语句SHOW是等效的。比如： 123456 openGauss=# SELECT current_setting('datestyle'); current_setting----------------- ISO, MDY(1 row) set_working_grand_version_num_manually(tmp_version) 描述：通过切换授权版本号来更新和升级高斯数据库的新特性。 返回值类型：void shell_in(type) 描述：为shell类型输入路由(那些尚未填充的类型)。 返回值类型：void shell_out(type) 描述：为shell类型输出路由（那些尚未填充的类型）。 返回值类型：void set_config(setting_name, new_value, is_local) 描述：设置参数并返回新值。 返回值类型：text 备注：set_config将参数setting_name设置为new_value，如果is_local为true，则新值将只应用于当前事务。如果希望新值应用于当前会话，可以使用false，和SQL语句SET是等效的。 示例： 123456 openGauss=# SELECT set_config('log_statement_stats', 'off', false); set_config------------ off(1 row) 父主题： 系统管理函数

条件表达式函数 coalesce(expr1, expr2, ..., exprn) 描述： 返回参数列表中第一个非NULL的参数值。 COALESCE(expr1, expr2) 等价于CASE WHEN expr1 IS NOT NULL THEN expr1 ELSE expr2 END。 示例： 12345 openGauss=# SELECT coalesce(NULL,'hello'); coalesce---------- hello(1 row) 备注： 如果表达式列表中的所有表达式都等于NULL，则本函数返回NULL。 它常用于在显示数据时用缺省值替换NULL。 和CASE表达式一样，COALESCE不会计算不需要用来判断结果的参数；即在第一个非空参数右边的参数不会被计算。 decode(base_expr, compare1, value1, Compare2,value2, … default) 描述：把base_expr与后面的每个compare(n) 进行比较，如果匹配返回相应的value(n)。如果没有发生匹配，则返回default。 示例： 12345 openGauss=# SELECT decode('A','A',1,'B',2,0); case------ 1(1 row) nullif(expr1, expr2) 描述：当且仅当expr1和expr2相等时，NULLIF才返回NULL，否则它返回expr1。 nullif(expr1, expr2) 逻辑上等价于CASE WHEN expr1 = expr2 THEN NULL ELSE expr1 END。 示例： 12345 openGauss=# SELECT nullif('hello','world'); nullif -------- hello(1 row) 备注： 如果两个参数的数据类型不同，则： 若两种数据类型之间存在隐式转换，则以其中优先级较高的数据类型为基准将另一个参数隐式转换成该类型，转换成功则进行计算，转换失败则返回错误。如： 12345 openGauss=# SELECT nullif('1234'::VARCHAR,123::INT4); nullif -------- 1234(1 row) 12 openGauss=# SELECT nullif('1234'::VARCHAR,'2012-12-24'::DATE);ERROR: invalid input syntax for type timestamp: "1234" 若两种数据类型之间不存在隐式转换，则返回错误 。如： 12345 openGauss=# SELECT nullif(TRUE::BOOLEAN,'2012-12-24'::DATE);ERROR: operator does not exist: boolean = timestamp without time zoneLINE 1: SELECT nullif(TRUE::BOOLEAN,'2012-12-24'::DATE) FROM sys_dummy;^HINT: No operator matches the given name and argument type(s). You might need to add explicit type casts. nvl( expr1 , expr2 ) 描述： 如果expr1为NULL则返回expr2。 如果expr1非NULL，则返回expr1。 示例： 12345 openGauss=# SELECT nvl('hello','world'); nvl ------- hello(1 row) 备注：参数expr1和expr2可以为任意类型，当NVL的两个参数不属于同类型时，看第二个参数是否可以向第一个参数进行隐式转换，如果可以则返回第一个参数类型。如果第二个参数不能向第一个参数进行隐式转换而第一个参数可以向第二个参数进行隐式转换，则返回第二个参数的类型。如果两个参数之间不存在隐式类型转换并且也不属于同一类型则报错。 greatest(expr1 [, ...]) 描述：获取并返回参数列表中值最大的表达式的值。 返回值类型： 示例： 12345 openGauss=# SELECT greatest(1*2,2-3,4-1); greatest ---------- 3(1 row) 12345 openGauss=# SELECT greatest('HARRY', 'HARRIOT', 'HAROLD'); greatest ---------- HARRY(1 row) least(expr1 [, ...]) 描述：获取并返回参数列表中值最小的表达式的值。 示例： 12345 openGauss=# SELECT least(1*2,2-3,4-1); least ------- -1(1 row) 12345 openGauss=# SELECT least('HARRY','HARRIOT','HAROLD'); least -------- HAROLD(1 row) EMPTY_BLOB() 描述：使用EMPTY_BLOB在INSERT或UPDATE语句中初始化一个BLOB变量，取值为NULL。 返回值类型：BLOB 示例： 123456 --新建表openGauss=# CREATE TABLE blob_tb(b blob,id int) DISTRIBUTE BY REPLICATION;--插入数据openGauss=# INSERT INTO blob_tb VALUES (empty_blob(),1);--删除表openGauss=# DROP TABLE blob_tb; 备注：使用DBE_LOB.GET_LENGTH求得的长度为0。

示例 byteawithoutorderwithequalcolin、byteawithoutorderwithequalcolout等函数为数据库内核中数据类型byteawithoutorderwithequalcol指定的in、out、send、recv等读写格式转换函数，具体可参考bytea类型的byteain、byteaout等函数，但会对本地的cek进行验证，需要密文字段中有本地存在的cekoid才能执行成功。 1 2 3 4 5 6 7 8 9101112131415 -- 例如存在加密表int_type，int_col2为其加密列-- 使用非密态客户端连接数据库，查询加密列密文openGauss=# select int_col2 from int_type; int_col2------------------------------------------------------------------------------------------------------------------------------------------------------ \x01c35301bf421c8edf38c34704bcc82838742917778ccb402a1b7452ad4a6ac7371acc0ac33100000035fe3424919854c86194f1aa5bb4e1ca656e8fc6d05324a1419b69f488bdc3c6(1 row)-- 将加密列密文当做byteawithoutorderwithequalcolin入参，格式从cstring输入转码转化成内部byteawithoutorderwithequalcol形式openGauss=# select byteawithoutorderwithequalcolin('\x01c35301bf421c8edf38c34704bcc82838742917778ccb402a1b7452ad4a6ac7371acc0ac33100000035fe3424919854c86194f1aa5bb4e1ca656e8fc6d05324a1419b69f488bdc3c6'); byteawithoutorderwithequalcolin------------------------------------------------------------------------------------------------------------------------------------------------------ \x01c35301bf421c8edf38c34704bcc82838742917778ccb402a1b7452ad4a6ac7371acc0ac33100000035fe3424919854c86194f1aa5bb4e1ca656e8fc6d05324a1419b69f488bdc3c6(1 row) 由于byteawithoutorderwithequalcolin等的实现会对cek进行查找，并且判断是否为正常加密后的数据类型。 因此如果用户输入数据的格式不是加密后的数据格式，并且在本地不存在对应cek的情况下，会返回错误。 1 2 3 4 5 6 7 8 9101112131415 openGauss=# SELECT * FROM byteawithoutorderwithequalcolsend('\x907219912381298461289346129'::byteawithoutorderwithequalcol);ERROR: cek with OID 596711794 not foundLINE 1: SELECT * FROM byteawithoutorderwithequalcolsend('\x907219912... ^openGauss=# SELECT * FROM byteawithoutordercolout('\x90721901999999999999912381298461289346129');ERROR: cek with OID 2566986098 not foundLINE 1: SELECT * FROM byteawithoutordercolout('\x9072190199999999999... SELECT * FROM byteawithoutorderwithequalcolrecv('\x90721901999999999999912381298461289346129'::byteawithoutorderwithequalcol);ERROR: cek with OID 2566986098 not found ^openGauss=# SELECT * FROM byteawithoutorderwithequalcolsend('\x90721901999999999999912381298461289346129'::byteawithoutorderwithequalcol);ERROR: cek with OID 2566986098 not foundLINE 1: SELECT * FROM byteawithoutorderwithequalcolsend('\x907219019... ^

下标生成函数 generate_subscripts(array anyarray, dim int) 描述：生成一系列包括给定数组的下标。 返回值类型：setof int generate_subscripts(array anyarray, dim int, reverse boolean) 描述：生成一系列包括给定数组的下标。当reverse为真时，该系列则以相反的顺序返回。 返回值类型：setof int

序列号生成函数 generate_series(start, stop) 描述：生成一个数值序列，从start到stop，步长为1。 参数类型：int、bigint、numeric 返回值类型：setof int、setof bigint、setof numeric（与参数类型相同） generate_series(start, stop, step) 描述：生成一个数值序列，从start到stop，步长为step。 参数类型：int、bigint、numeric 返回值类型：setof int、setof bigint、setof numeric（与参数类型相同） generate_series(start, stop, step interval) 描述：生成一个数值序列，从start到stop，步长为step。 参数类型：timestamp或timestamp with time zone 返回值类型：setof timestamp或setof timestamp with time zone（与参数类型相同）

废弃函数 由于版本升级，HLL（HyperLogLog）有一些旧的函数废弃，用户可以用类似的函数进行替代。 hll_schema_version(hll) 描述：查看当前hll中的schema version。旧版本schema version是常值1，用来进行hll字段的头部校验，重构后的hll在头部增加字段“HLL”进行校验，schema version不再使用。 hll_regwidth(hll) 描述：查看hll数据结构中桶的位数大小。旧版本桶的位数regwidth取值1~5，会存在较大的误差，也限制了基数估计上限。 重构后regwidth为固定值6，不再使用regwidth变量。 hll_expthresh(hll) 描述：得到当前hll中expthresh大小。采用hll_log2explicit(hll)替代类似功能。 hll_sparseon(hll) 描述：是否启用Sparse模式。采用hll_log2sparse(hll)替代类似功能，0表示关闭Sparse模式。

聚合函数 hll_add_agg(hll_hashval) 描述：把哈希后的数据按照分组放到hll中。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 910111213141516171819 --准备数据openGauss=# create table t_id(id int);openGauss=# insert into t_id values(generate_series(1,500));openGauss=# create table t_data(a int, c text);openGauss=# insert into t_data select mod(id,2), id from t_id;--创建表并指定列为hllopenGauss=# create table t_a_c_hll(a int, c hll);--根据a列group by对数据分组，把各组数据加到hll中openGauss=# insert into t_a_c_hll select a, hll_add_agg(hll_hash_text(c)) from t_data group by a;--得到每组数据中hll的Distinct值openGauss=# select a, #c as cardinality from t_a_c_hll order by a; a | cardinality ---+------------------ 0 | 247.862354346299 1 | 250.908710610377(2 rows)

操作符 = 描述：比较hll或hll_hashval的值是否相等。 返回值类型：bool 示例： 1 2 3 4 5 6 7 8 910111213 --hllopenGauss=# select (hll_empty() || hll_hash_integer(1)) = (hll_empty() || hll_hash_integer(1));column ---------- t(1 row)--hll_hashvalopenGauss=# select hll_hash_integer(1) = hll_hash_integer(1); ?column? ---------- t(1 row)

日志函数 hll主要存在三种模式Explicit，Sparse，Full。当数据规模比较小的时候会使用Explicit模式，这种模式下distinct值的计算是没有误差的；随着distinct值越来越多，hll会先后转换为Sparse模式和Full模式，这两种模式在计算结果上没有任何区别，只影响hll函数的计算效率和hll对象的存储空间。下面的函数可以用于查看hll的一些参数。 hll_print(hll) 描述：打印hll的一些debug参数信息。 示例： 12345 openGauss=# select hll_print(hll_empty()); hll_print------------------------------------------------------------------------------- type=1(HLL_EMPTY), log2m=14, log2explicit=10, log2sparse=12, duplicatecheck=0(1 row)

功能函数 hll_empty() 描述：创建一个空的hll。 返回值类型：hll 示例： 12345 openGauss=# select hll_empty(); hll_empty------------------------------------------------------------ \x484c4c00000000002b05000000000000000000000000000000000000(1 row) hll_empty(int32 log2m) 描述：创建空的hll并指定参数log2m，取值范围是10到16。若输入-1，则采用内置默认值。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 91011 openGauss=# select hll_empty(10); hll_empty------------------------------------------------------------ \x484c4c00000000002b04000000000000000000000000000000000000(1 row)openGauss=# select hll_empty(-1); hll_empty------------------------------------------------------------ \x484c4c00000000002b05000000000000000000000000000000000000(1 row) hll_empty(int32 log2m, int32 log2explicit) 描述：创建空的hll并依次指定参数log2m、log2explicit。log2explicit取值范围是0到12，0表示直接跳过Explicit模式。该参数可以用来设置Explicit模式的阈值大小，在数据段长度达到2log2explicit后切换为Sparse模式或者Full模式。若输入-1，则log2explicit采用内置默认值。 返回值类型: hll 示例： 1 2 3 4 5 6 7 8 91011 openGauss=# select hll_empty(10, 4); hll_empty------------------------------------------------------------ \x484c4c00000000001304000000000000000000000000000000000000(1 row)openGauss=# select hll_empty(10, -1); hll_empty------------------------------------------------------------ \x484c4c00000000002b04000000000000000000000000000000000000(1 row) hll_empty(int32 log2m, int32 log2explicit, int64 log2sparse) 描述：创建空的hll并依次指定参数log2m、log2explicit、log2sparse。log2sparse取值范围是0到14，0表示直接跳过Sparse模式。该参数可以用来设置Sparse模式的阈值大小，在数据段长度达到2log2sparse后切换为Full模式。若输入-1，则log2sparse采用内置默认值。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 91011 openGauss=# select hll_empty(10, 4, 8); hll_empty------------------------------------------------------------ \x484c4c00000000001204000000000000000000000000000000000000(1 row)openGauss=# select hll_empty(10, 4, -1); hll_empty------------------------------------------------------------ \x484c4c00000000001304000000000000000000000000000000000000(1 row) hll_empty(int32 log2m, int32 log2explicit, int64 log2sparse, int32 duplicatecheck) 描述：创建空的hll并依次指定参数log2m、log2explicit、log2sparse、duplicatecheck。duplicatecheck取0或者1，表示是否开启该模式，默认情况下该模式会关闭。若输入-1，则duplicatecheck采用内置默认值。 返回值类型：hll 示例： 1 2 3 4 5 6 7 8 91011 openGauss=# select hll_empty(10, 4, 8, 0); hll_empty------------------------------------------------------------ \x484c4c00000000001204000000000000000000000000000000000000(1 row)openGauss=# select hll_empty(10, 4, 8, -1); hll_empty------------------------------------------------------------ \x484c4c00000000001204000000000000000000000000000000000000(1 row) hll_add(hll, hll_hashval) 描述：把hll_hashval加入到hll中。 返回值类型：hll 示例： 12345 openGauss=# select hll_add(hll_empty(), hll_hash_integer(1)); hll_add---------------------------------------------------------------------------- \x484c4c08000002002b0900000000000000f03f3e2921ff133fbaed3e2921ff133fbaed00(1 row) hll_add_rev(hll_hashval, hll) 描述：把hll_hashval加入到hll中，和hll_add功能一样，只是参数位置进行了交换。 返回值类型：hll 示例： 12345 openGauss=# select hll_add_rev(hll_hash_integer(1), hll_empty()); hll_add_rev---------------------------------------------------------------------------- \x484c4c08000002002b0900000000000000f03f3e2921ff133fbaed3e2921ff133fbaed00(1 row) hll_eq(hll, hll) 描述：比较两个hll是否相等。 返回值类型：bool 示例： 12345 openGauss=# select hll_eq(hll_add(hll_empty(), hll_hash_integer(1)), hll_add(hll_empty(), hll_hash_integer(2))); hll_eq -------- f(1 row) hll_ne(hll, hll) 描述：比较两个hll是否不相等。 返回值类型：bool 示例： 12345 openGauss=# select hll_ne(hll_add(hll_empty(), hll_hash_integer(1)), hll_add(hll_empty(), hll_hash_integer(2))); hll_ne -------- t(1 row) hll_cardinality(hll) 描述：计算hll的distinct值。 返回值类型：int 示例： 12345 openGauss=# select hll_cardinality(hll_empty() || hll_hash_integer(1)); hll_cardinality ----------------- 1(1 row) hll_union(hll, hll) 描述：把两个hll数据结构union成一个。 返回值类型：hll 示例： 12345 openGauss=# select hll_union(hll_add(hll_empty(), hll_hash_integer(1)), hll_add(hll_empty(), hll_hash_integer(2))); hll_union-------------------------------------------------------------------------------------------- \x484c4c10002000002b090000000000000000400000000000000000b3ccc49320cca1ae3e2921ff133fbaed00(1 row)

账本数据库的函数 当前特性是实验室特性，使用时请联系华为工程师提供技术支持。 get_dn_hist_relhash(text, text) 描述：返回指定防篡改用户表的表级数据hash值。该函数仅供分布式节点间调用，所有用户调用均提示权限不足。 参数类型：text 返回值类型：hash16 ledger_hist_check(text, text) 描述：校验指定防篡改用户表的表级数据hash值与其对应历史表hash一致性。 参数类型：text 返回值类型：Boolean ledger_hist_repair(text, text) 描述：修复指定防篡改用户表对应的历史表hash值，使之与用户表hash一致，返回hash差值。 参数类型：text 返回值类型：hash16 ledger_hist_archive(text, text) 描述：归档指定防篡改用户表对应的历史表至审计日志目录中hist_back文件夹下。 参数类型：text 返回值类型：Boolean ledger_gchain_check(text, text) 描述：校验指定防篡改用户表对应的历史表hash与全局历史表对应的relhash一致性。 参数类型：text 返回值类型：Boolean ledger_gchain_repair(text, text) 描述：修复验指定防篡改用户表在全局历史表中的relhash，使之与其历史表hash一致，返回hash差值。 参数类型：text 返回值类型：hash16 ledger_gchain_archive(void) 描述：归档全局历史表至审计日志目录中hist_back文件夹下。 参数类型：void 返回值类型：Boolean hash16in(cstring) 描述：将输入16进制字符串转化成内部hash16形式。 参数类型：cstring 返回值类型：hash16 hash16out(uint64) 描述：将内部hash16类型的数据转码转化为16进制cstring类型。 参数类型：hash16 返回值类型：cstring hash32in(cstring) 描述：将输入的16进制字符串(32个字符)转化成内部类型hash32形式。 参数类型：cstring 返回值类型：hash32 hash32out(hash32) 描述：将内部hash32类型的数据转码转化为16进制cstring类型。 参数类型：cstring 返回值类型：hash32 父主题： 函数和操作符