其它函数

描述：获取前一次查询语句的seed值（内部使用）。

返回值类型：int

描述：获取当前节点的环境变量信息，仅sysadmin和monitor admin可以访问。

返回值类型：record

示例：

gaussdb=# select pg_stat_get_env();
                                                                              pg_stat_get_env
---------------------------------------------------------------------------------------------------------------------------------------
 (sgnode,"localhost,XXX.XXX.XXX.XXX",28589,26000,/home/omm,/home/omm/data/single_node,pg_log)
(1 row)

描述：清理节点上无人使用的全局计划缓存。

返回值类型：bool

描述：显示节点上全局计划缓存的信息，函数返回信息和GLOBAL_PLANCACHE_STATUS一致。

返回值类型：record

描述：提供查询text的逻辑长度的方法。

返回值类型：int

描述：显示线程池中工作线程及会话的状态信息。

返回值类型：record

描述：提供当前节点保存在内存中的历史活跃session状态的采样记录。

返回值类型：record

描述：提供当前节点下所有线程的状态信息，sysadmin和monitor admin用户可以查看所有线程信息，普通用户查看本用户的线程信息。

返回值类型：record

描述：提供当前节点中用户执行的SELECT/UPDATE/INSERT/DELETE/MERGE INTO语句的计数结果，sysadmin和monitor admin用户可以查看所有用户的信息，普通用户查看本用户的统计信息。

返回值类型：record

描述：提供当前活跃的数据复制发送线程的详细信息。

返回值类型：record

描述：提供wait event事件的具体信息。

返回值类型：record

描述：基于两个snapshot生成系统诊断报告。需要在系统库下执行，默认初始化用户或monadmin用户可以访问。只可在系统库中查询到结果，用户库中无法查询。

返回值类型：record

描述：手工生成系统诊断快照，该函数需要sysadmin权限。

返回值类型：text

描述：kill后台的WDR snapshot线程，调用该函数的用户需要具有SYSADMIN权限或具有REPLICATION权限或继承了内置角色gs_role_replication的权限。

返回值类型：void

描述：将视图的结果存入GUC: perf_directory所指定的目录，如果is_crossdb为1，则表示对于所有的database都会访问一次view；如果is_crossdb为0，则表示仅对当前database进行一次视图访问。该函数只有sysadmin和monitor admin用户可以执行。

返回值类型：int

描述：用来清理数据库节点内存中的Unique SQL（需要sysadmin/monitor admin权限）。

返回值类型：bool

描述：提供本地跨数据库执行query的能力。例如：在连接到testdb库时，访问test库下的表，只有初始化用户才有权限执行。

select col1 from wdr_xdb_query('dbname=test','select col1 from t1') as dd(col1 int);

返回值类型：record

描述：调整任务到数据库主节点队列的最前端。

返回值类型：boolean

• true：成功。
• false：失败。

描述：调整作业的优先级到新控制组。

返回值类型：boolean

• true：成功。
• false：失败。

描述：将线程tid的MemoryContextName内存上下文信息记录到“$GAUSSLOG/pg_log/${node_name}/dumpmem”目录下的“threadid_timestamp.log”文件中。其中threadid可通过视图GS_SESSION_MEMORY_DETAIL中的sessid后获得。在正式发布的版本中仅接受MemoryContextName为空串（两个单引号表示输入为空串，即''）的输入，此时会记录所有的内存上下文信息，否则不会有任何操作。该函数需要管理员权限的用户才能执行。

返回值类型：boolean

• true：成功。
• false：失败。

描述：将MemoryContextName内存上下文信息记录到“$GAUSSLOG/pg_log/${node_name}/dumpmem”目录下的“threadid_timestamp.log”文件中。该函数功能仅在DEBUG版本中供内部开发人员和测试人员调试使用，在正式发布版本中调用该函数不会有任何操作。该函数需要管理员权限的用户才能执行。

返回值类型：boolean

• true：成功。
• false：失败。

描述：显示本实例的bgwriter线程刷页信息，候选buffer链中页面个数，buffer淘汰信息。

返回值类型：record

描述：显示本实例的候选buffer链中页面个数，buffer淘汰信息，包含normal buffer pool和segment buffer pool。

返回值类型：record

描述：显示本实例的检查点信息和各类日志刷页情况。

返回值类型：record

描述：显示本实例的双写文件的情况。

返回值类型：record

描述：显示本实例的单页面淘汰双写文件的情况。

返回值类型：record

描述：显示本实例的刷页信息和检查点信息。

返回值类型：record

描述：显示本实例的备机的当前回放状态。

返回值类型：record

备注：返回的回放状态主要包括当前回放位置，回放最小恢复点位置等信息。

描述：显示本实例的主机和备机的日志流控信息。

返回值类型：record

gs_wlm_node_recover(boolean isForce)

描述：获取当前内存中记录的TopSQL查询语句级别相关统计信息，当传入的参数不为0时，会将这部分信息从内存中清理掉。

返回值类型：record

描述：读取指定逻辑数据库的cgroup配置文件。

返回值类型：record

描述：切换指定会话的控制组。

返回值类型：record

描述：用于查询单个节点活跃的客户端连接信息。

返回值类型：setof record

描述：返回当前节点flush的xlog位置。

返回值类型：text

描述：返回当前节点多数派flush的xlog位置。

返回值类型：text

描述：获取数据库级的全量SQL(Full SQL)信息。只可在系统库中查询到结果，用户库中无法查询。

返回值类型：record

描述：获取数据库级的慢SQL(Slow SQL)信息。只可在系统库中查询到结果，用户库中无法查询。

返回值类型：record

描述：解析全量/慢SQL语句中的details字段的信息。只可在系统库中查询到结果，用户库中无法查询。

返回值类型：text

描述：返回系统控制文件状态。

返回类型：SETOF record

描述：返回系统检查点状态。

返回类型：SETOF record

描述：当恢复完成时，返回nextxid。

参数：nan

返回值类型：text

描述：清理regionmap。

参数：nan

返回值类型：character varying

描述：获取slot name。

参数：nan

返回值类型：text

描述：获取运行中的xact。

参数：nan

返回值类型：handle integer、gxid xid、state tinyint、node text、xmin xid、vacuum boolean、timeline bigint、prepare_xid xid、pid bigint、next_xid xid

描述：获取共享内存变量cache。

参数：nan

返回值类型：node_name text、nextOid oid、nextXid xid、oldestXid xid、xidVacLimit xid、oldestXidDB oid、lastExtendCSNLogpage xid、startExtendCSNLogpage xid、nextCommitSeqNo xid、latestCompletedXid xid、startupMaxXid xid

描述：从共享内存获取事物id信息。

参数：nan

返回值类型：nextXid xid、oldestXid xid、xidVacLimit xid、xidWarnLimit xid、xidStopLimit xid、xidWrapLimit xid、oldestXidDB oid

描述：查询表压缩率，默认返回1.0。

参数：text

返回值类型：real

描述：查询表是否压缩。

参数：text

返回值类型：boolean

描述：列出路径下所有文件。

参数：location text

返回值类型：path text、filename text、size bigint、isdir boolean

描述：返回临时表相关的后台进程的记录。

参数：nan

返回值类型：datid oid、timelineid integer、tempid integer、sessionid bigint

描述：返回nodegroup相关的后台进程的记录。

参数：pid bigint

返回值类型：datid oid、pid bigint、sessionid bigint、node_group text

描述：返回cgroup信息。

参数：nan

返回值类型：cgroup_name text、percent integer、usage_percent integer、shares bigint、usage bigint、cpuset text、relpath text、valid text、node_group text

描述：返回实时信息，当前该接口已不可用，返回FailedToGetSessionInfo。

参数：oid、oid, bigint、cstring、oid

返回值类型：text

描述：测试错误类型和返回信息。

参数：integer

返回值类型：void

描述：返回所有节点上各用户的事务相关信息。

返回值类型：node_name name、usename name、commit_counter bigint、rollback_counter bigint、resp_min bigint、resp_max bigint、resp_avg bigint、resp_total bigint、bg_commit_counter bigint、bg_rollback_counter bigint、bg_resp_min bigint、bg_resp_max bigint、bg_resp_avg bigint、bg_resp_total bigint

描述：返回入参字符串对应的排序规则。

参数：any（如果是常量必须进行显式类型转换）

返回值类型：text

该函数当前版本暂不可用。

该函数当前版本暂不可用。

描述：创建COPY FROM容错机制所需要的错误表（public.pgxc_copy_error_log）。

返回值类型：Boolean

• 此函数会尝试创建public.pgxc_copy_error_log表，表的详细信息请参见表7。
• 在relname列上创建B-tree索引，并REVOKE ALL on public.pgxc_copy_error_log FROM public对错误表进行权限控制（与COPY语句权限一致）。
• 由于尝试创建的public.pgxc_copy_error_log定义是一张行存表，因此数据库实例上必须支持行存表的创建才能够正常运行此函数，并使用后续的COPY容错功能。需要特别注意的是，enable_hadoop_env这个GUC参数开启后会禁止在数据库实例内创建行存表（GaussDB默认为off）。
• 此函数自身权限为Sysadmin及以上（与错误表、COPY权限一致）。
• 若创建前public.pgxc_copy_error_log表已存在或者copy_error_log_relname_idx索引已存在，则此函数会报错回滚。

描述：动态开启内置的功能，当前仅支持动态开启全量SQL。

返回值类型：record

描述：用于解析指定表页面，并返回存放解析内容的路径。

返回值类型：text

备注：必须是系统管理员或运维管理员才能执行此函数。

正常使用示例：

# 解析BTree索引文件中所有页面的信息内容
# 函数调用前请依据参数说明中的内容确保文件路径真实存在
gaussdb=# select gs_parse_page_bypath('base/16603/16394', -1, 'btree', false);
                        gs_parse_page_bypath                        
--------------------------------------------------------------------
 /data_dir/1663_16603_16394_-1.page
(1 row)

# 解析vm文件中所有block的可见性结果
gaussdb=# select gs_parse_page_bypath('base/12828/16771_vm', -1, 'vm', false);
                         gs_parse_page_bypath                          
-----------------------------------------------------------------------
 /data_dir/1663_12828_16771_-1_vm.page
(1 row)

# 解析clog文件中0号block的commit log日志
gaussdb=# select gs_parse_page_bypath('000000000000', 0, 'clog', false); 
                        gs_parse_page_bypath                        
--------------------------------------------------------------------
 /data_dir/000000000000.clog
(1 row)

异常场景报错示例：

# 入参blocknum超出取值范围时报错
gaussdb=# select gs_parse_page_bypath('base/12828/16777', -10, 'heap', false);
ERROR:  Blocknum should be between -1 and 4294967294.
CONTEXT:  referenced column: gs_parse_page_bypath

gs_xlogdump_lsn(start_lsn text, end_lsn text)

描述：用于解析指定lsn范围之内的XLOG日志，并返回存放解析内容的路径。可以通过pg_current_xlog_location()获取当前XLOG位置。

返回值类型：text

参数：LSN起始位置，LSN结束位置

备注：必须是系统管理员或运维管理员才能执行此函数。

gs_xlogdump_xid(c_xid xid)

描述：用于解析指定xid的XLOG日志，并返回存放解析内容的路径。可以通过txid_current()获取当前事务ID。

参数：事务ID

返回值类型：text

备注：必须是系统管理员或运维管理员才能执行此函数。

描述：用于解析指定表页面对应的日志，并返回存放解析内容的路径。

返回值类型：text

备注：必须是系统管理员或运维管理员才能执行此函数。

描述：用于解析指定表页面和表页面对应的日志，并返回存放解析内容的路径。可以看做一次执行gs_parse_page_bypath和gs_xlogdump_tablepath。该函数执行的前置条件是表文件存在。如果想查看已删除的表的相关日志，请直接调用gs_xlogdump_tablepath。

返回值类型：text

备注：必须是系统管理员或运维管理员才能执行此函数。

描述：用于校验UBtree索引页面或者索引树上key的顺序是否正确。

返回值类型：record

描述：用于解析UBtree索引回收队列信息。

返回值类型：record

描述：用于输出xlog中预写日志插入状态表的内容。

返回值类型：record

描述：输出预写日志的刷新位置。

返回值类型：record

描述：用于统计预写日志write与sync的次数频率与数据量，以及xlog文件的信息。

返回值类型：record

描述：对于指定的系统表oid，返回该系统表对应的各个字段的定义。仅支持oid小于10000的普通系统表（不支持索引、toast表等）。

参数：系统表oid

返回值类型：record

描述：用于在数据库实例配置用户态网络的场景下，代理通信库comm_proxy收发数据包统计。

参数：nan

返回值类型：record

此函数的查询仅在集中式环境开始部署用户态网络，且comm_proxy_attr参数中enable_dfx配置为true的条件下显示具体信息。其他场景报错不支持查询。

描述：返回默认表空间下临时目录（pgsql_tmp）中每个文件的名称、大小和最后修改时间。

参数：nan

返回值类型：record

备注：必须是系统管理员或者监控管理员才能执行此函数。

描述：返回指定表空间下临时目录（pgsql_tmp）中每个文件的名称、大小和最后修改时间。

参数：oid

返回值类型：record

备注：必须是系统管理员或者监控管理员才能执行此函数。

描述：返回预写日志(WAL)目录中每个文件的名称、大小和最后修改时间。

参数：nan

返回值类型：record

备注：必须是系统管理员或者监控管理员才能执行此函数。

描述：写入一条日志记录DN节点当前的term值。备DN节点返回false，主DN节点写入成功后返回true。

返回值类型：Boolean

描述：用于查询UStore中做Insert操作时拓展页面的状态。

返回值类型：record

示例：

gaussdb=# select * from gs_stat_space(false);
 access_func | cache_blk | cache_succ | nblk_first | nblk_first_succ | nblk_sencond | nblk_sencond_succ | fsm_first | fsm_first_success | fsm_rewrite | fsm_
second | fsm_second_success | prune_count | prune_space | coprune_count | coprune_scan_blocks | coprune_prune_count | coprune_prune_space | con_extend_count
 | con_extend_time | single_extend_count
-------------+-----------+------------+------------+-----------------+--------------+-------------------+-----------+-------------------+-------------+-----
-------+--------------------+-------------+-------------+---------------+---------------------+---------------------+---------------------+-----------------
-+-----------------+---------------------
    10082397 |  10082397 |   10082235 |         88 |              78 |        47021 |             47021 |       162 |                74 |      360996 |
360996 |             270948 |        6711 |           0 |         45497 |              222619 |                   0 |                   0 |             3675
 |        25542884 |               26791
(1 row)

备注：请重点关注cache_succ此值较小说明系统缓存失效，prune_space 此值较小表示UStore数据页页面清理机制可能存在问题，con_extend_time此值过高可能表明UStore并发拓页时耗时较高。

描述：用于查询索引获取新页面时在循环队列中产生的buffer read信息和索引页面相同key从左到右遍历叶子页面的buffer read信息。

返回值类型：record

• 该接口当前仅支持USTORE索引表。
• 该接口执行时，先reset清理、将记录全部置为0。再进行查询，直到下次统计到信息值之前，查询记录会一直为0。查询示例如下：

  gaussdb=# select * from gs_index_dump_read(0, 'all');
  relfilenode | max_count | ave_count
  --------------+-------------+-------------
  |                     |
  (1 row)
  gaussdb=# select * from gs_index_dump_read(1, 'all');
  relfilenode | max_count | ave_count
  --------------+-------------+-------------
  0 |                  0 |                  0
  0 |                  0 |                  0
  (2 rows)

描述：用于将备份的特定UStore数据页面重放到指定LSN，并在重放期间校验页面，若检测到页面受损或页面记录受损则告警受损信息，并在重放后落盘页面，返回落盘路径、页面LSN以及受损信息，否则重放至指定LSN并落盘页面后返回，必须是系统管理员或运维管理员才能执行此函数。

返回值类型：record

描述：根据parent_id获取某个时间段内，执行某个存储过程的数据库级的全量SQL及其子语句的记录。只可在系统库中查询到结果，用户库中无法查询。

返回值类型：record

示例：

gaussdb=# CREATE TABLE test(a int,b int);
CREATE TABLE
gaussdb=# INSERT INTO test values(1,1);
INSERT 0 1
gaussdb=# CREATE PROCEDURE mypro1() as num int;
gaussdb$# begin
gaussdb$# INSERT INTO test values(2,2);
gaussdb$# DELETE FROM test where a = 2;
gaussdb$# end;
gaussdb$# /
CREATE PROCEDURE

# 打开参数，跟踪存储过程子语句。
gaussdb=# SET instr_unique_sql_track_type = 'all';
SET

# 打开参数，dbe_perf.statement_history表生成全量语句记录。
gaussdb=# SET track_stmt_stat_level = 'L0,L0';
SET

gaussdb=# CALL mypro1();
 mypro1
--------

(1 row)

gaussdb=# SET track_stmt_stat_level = 'off,L0';
SET

gaussdb=# SET instr_unique_sql_track_type = 'top';
SET

# 查询关键信息，作为函数参数使用。
gaussdb=# SELECT query,unique_query_id,start_time,finish_time FROM dbe_perf.statement_history;
                query                 | unique_query_id |          start_time           |          finish_time
--------------------------------------+-----------------+-------------------------------+-------------------------------
 set track_stmt_stat_level = 'L0,L0'; |       636388010 | 2023-06-02 17:40:49.176155+08 | 2023-06-02 17:40:49.176543+08
 call mypro1();                       |       536458473 | 2023-06-02 17:40:59.028144+08 | 2023-06-02 17:40:59.032027+08
 delete from test where a = ?         |       583323884 | 2023-06-02 17:40:59.029955+08 | 2023-06-02 17:40:59.031577+08
 insert into test values(?,?)         |       769279931 | 2023-06-02 17:40:59.029219+08 | 2023-06-02 17:40:59.029947+08
(4 rows)

# 通过外层语句的unique_query_id，开始时间的起止时间作为参数，查询该时间段内，指定存储过程及其子语句的信息。
gaussdb=# SELECT query FROM dbe_perf.get_full_sql_by_parent_id_and_timestamp(536458473,'2023-06-02 17:40:59.028144+08','2023-06-02 17:40:59.032027+08');
            query
------------------------------
 call mypro1();
 delete from test where a = ?
 insert into test values(?,?)
(3 rows)

描述：传入一个页面LSN以及块号，解析LSN对应的WAL日志，并获取对应块号的last LSN继续解析，直到last LSN为0或者更老版本的WAL日志已被复用回收，并将解析后的日志落盘到指定路径，必须是系统管理员或运维管理员才能执行此函数。本系统函数不支持备机调用。

返回值类型：text

# 获取页面LSN信息
# 函数调用前请依据参数说明中的内容确保文件路径真实存在
gaussdb=# select * from gs_parse_page_bypath('base/15833/16768', 0, 'uheap', false);
                        output_filepath
---------------------------------------------------------------
 /data1/database/cluster/primary/data/1663_15833_16768_0.page
(1 row)
gaussdb=# select * from gs_xlogdump_bylastlsn('0/4593570', -1, 'uheap');
                        output_filepath
-------------------------------------------------------------------
 /data1/database/cluster/primary/data/pg_log/dump/4593570_-1.xlog
(1 row)
gaussdb=# select * from gs_xlogdump_bylastlsn('0/4593570', 0, 'ubtree');
ERROR:  The input lsn 0/4593570 related xlog is not ubtree.