其它函数

plan_seed()

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

返回值类型：int

pg_stat_get_env()

描述：获取当前节点的环境变量信息，仅sysadmin和monitor admin可以访问。多租场景下，PDB内部返回为空。

返回值类型：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,gs_log)
(1 row)

pg_catalog.plancache_clean()

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

返回值类型：Boolean

pg_catalog.plancache_status()

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

返回值类型：record

textlen(text)

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

返回值类型：int

threadpool_status()

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

在多租场景下，Non-PDB可见全局数据；主节点下在PDB内部仅可见PDB自身数据；备节点不做线程组隔离，在PDB内部查询返回空。

返回值类型：record

get_local_active_session()

描述：提供当前节点保存在内存中的历史活跃session状态的采样记录。多租场景下，在PDB内部仅可见PDB自己的数据，Non-PDB可见全局数据。

返回值类型：record

pg_stat_get_thread()

描述：提供当前节点下所有线程的状态信息，sysadmin和monitor admin用户可以查看所有线程信息，普通用户查看本用户的线程信息。多租场景下，non-PDB调用该函数时返回全部信息，PDB调用该函数时仅返回该PDB相关信息。

返回值类型：record

pg_stat_get_sql_count()

描述：提供当前节点中用户执行的SELECT/UPDATE/INSERT/DELETE/MERGE INTO语句的计数结果和DDL/DML/DCL语句的计数结果。DDL语句包括“TRUNCATE”、“VACUUM”、“ANALYZE”、“CREATE”（不包括“CREATE ROLE”和“CREATE USER”）、“DROP”（不包括“DROP ROLE”和“DROP USER”）、“ALTER”（不包括“ALTER ROLE”、“ALTER USER”和“ALTER DEFAULT PRIVILEGES”）、“REINDEX”和“COMMENT”语句。DML语句包括“UPDATE”、“INSERT”、“DELETE”、“MERGE”、“PREPARE”、“EXPLAIN”、“SHOW”、“LOCK”、“COPY”、“CLUSTER”、“ANONYMOUS”、“DELTA”、“EXECUTE”、“MOVE”、“FETCH”、“CLOSE”、“DEALLOCATE”、“DECLARE”和“LOAD”语句。DCL语句包括“CREATE ROLE”、“CREATE USER”、“DROP ROLE”、“DROP USER”、“ALTER ROLE”、“ALTER USER”、“ALTER DEFAULT PRIVILEGES”、“GRANT”、“REVOKE”、“REASSIGN”和“SET”语句。sysadmin和monitor admin用户可以查看所有用户的信息，普通用户查看本用户的统计信息。多租场景下，non-PDB调用该函数时返回全部信息，PDB调用该函数时仅返回该PDB相关信息。

返回值类型：record

pg_stat_get_data_senders()

描述：提供当前活跃的数据复制发送线程的详细信息。多租场景下，PDB内部返回为空。

返回值类型：record

get_wait_event_info()

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

返回值类型：record

generate_wdr_report(begin_snap_id bigint, end_snap_id bigint, report_type cstring, report_scope cstring, node_name cstring)

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

返回值类型：record

generate_wdr_db_report(db_name cstring, begin_snap_id bigint, end_snap_id bigint, report_type cstring, report_scope cstring, node_name cstring)

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

返回值类型：record

create_wdr_snapshot()

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

返回值类型：text

kill_snapshot()

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

返回值类型：void

generate_asp_report(start_time timestamp with time zone, end_time timestamp with time zone, slot_count bigint, node_name text)

描述：基于时间戳生成ASP诊断报告，monadmin用户可以访问。slot_count为指标展示时分隔的时间段的个数。node_name用于生成指定节点的ASP报告，取值可以是主备CN的名称，可缺省。缺省时，生成当前节点的报告。该函数只能在主DN上使用。

返回值类型：text

dbe_perf.get_active_session_profile(start_ts timestamp with time zone, end_ts timestamp with time zone, need_final boolean,node_name text)

描述：基于时间戳查询asp内存中与磁盘中的数据。need_final是否查询阻塞信息，默认值为false。node_name用于区分主备DN，如（dn_6001或dn_6002），不可缺省。多租场景下，PDB中查询PDB数据，连接到Non-PDB可查所有数据。

返回值类型：record

capture_view_to_json(text,integer)

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

返回值类型：int

reset_unique_sql(text,text,bigint)

描述：用来清理数据库节点内存中的Unique SQL（需要sysadmin/monitor admin权限）。多租场景下，在PDB调用仅清理PDB的数据，在Non-PDB调用会清理全局的数据。

返回值类型：Boolean

wdr_xdb_query(db_name_str text, query text)

描述：提供本地跨数据库执行query的能力。例如：在连接到testdb库时，访问test库下的表，只有初始化用户才有权限执行。多租场景下，non-PDB调用该函数时正常运行，PDB调用该函数时报错。

SELECT col1 FROM wdr_xdb_query('dbname=test','SELECT col1 FROM t1') AS dd(col1 int);

返回值类型：record

pg_wlm_jump_queue(pid int)

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

返回值类型：boolean

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

gs_wlm_switch_cgroup(pid int, cgroup text)

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

返回值类型：boolean

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

pv_session_memctx_detail(threadid tid, MemoryContextName text)

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

返回值类型：boolean

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

pg_shared_memctx_detail(MemoryContextName text)

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

返回值类型：boolean

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

local_aio_completer_stat()

描述：显示本实例中AIO Completer线程的相关统计信息。

返回值类型：record

local_aio_slot_usage_status()

描述：显示本实例中异步I/O提交槽位的相关统计信息。

返回值类型：record

gs_get_io_type()

描述：显示本实例的I/O模式。

返回值类型：text

• BIO：表示当前实例正以BIO模式运行（即ADIO未打开）。
• DIO：表示当前实例正以DIO模式运行（即ADIO已打开）。
• BIO->DIO (In progress)：表示当前实例正在从BIO到DIO模式的切换过程中。

local_bgwriter_stat()

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

返回值类型：record

local_candidate_stat()

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

返回值类型：record

local_ckpt_stat()

描述：显示本实例的检查点信息和各类日志刷页情况。多租场景下，non-PDB调用该函数时正常运行，PDB调用该函数时返回空列表。

返回值类型：record

local_double_write_stat()

描述：显示本实例的双写文件的情况。多租场景下，non-PDB调用该函数时返回全部信息，PDB调用该函数时返回空列表。

返回值类型：record

local_single_flush_dw_stat()

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

返回值类型：record

local_pagewriter_stat()

描述：显示本实例的刷页信息和检查点信息。多租场景下，non-PDB调用该函数时正常运行，PDB调用该函数时返回空列表。

返回值类型：record

local_redo_stat()

描述：显示本实例的备机的当前回放状态。多租场景下，non-PDB调用该函数时正常运行，PDB调用该函数时返回空列表。

返回值类型：record

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

local_recovery_status()

描述：显示本实例的主机和备机的日志流控信息。多租场景下，non-PDB调用该函数时正常运行，PDB调用该函数时返回空列表。

返回值类型：record

gs_wlm_node_recover(boolean isForce)

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

返回值类型：record

gs_cgroup_map_ng_conf(group name)

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

返回值类型：record

gs_wlm_switch_cgroup(sess_id int8, cgroup name)

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

返回值类型：record

comm_client_info()

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

返回值类型：setof record

pg_get_flush_lsn()

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

返回值类型：text

pg_get_sync_flush_lsn()

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

返回值类型：text

dbe_perf.get_global_full_sql_by_timestamp(start_timestamp timestamp with time zone, end_timestamp timestamp with time zone)

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

返回值类型：record

dbe_perf.get_global_slow_sql_by_timestamp(start_timestamp timestamp with time zone, end_timestamp timestamp with time zone)

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

返回值类型：record

statement_detail_decode(detail text, format text, pretty boolean)

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

返回值类型：text

pgxc_get_csn(tid)

描述：返回给定的事务id对应的事务提交序号（CSN）。

返回值类型：int8

pgxc_get_csn(tid, bucketid)

描述：当前版本集中式不支持hashbucket 表，该接口函数调用报错。

pg_control_system()

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

返回类型：SETOF record

pg_control_checkpoint()

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

返回类型：SETOF record

get_prepared_pending_xid()

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

参数：nan

返回值类型：text

pg_clean_region_info()

描述：清理regionmap。

参数：nan

返回值类型：character varying

pg_get_replication_slot_name

描述：获取slot name。

参数：nan

返回值类型：text

pg_get_running_xacts()

描述：获取运行中的xact。多租场景下，non-PDB调用该函数时返回全部信息，PDB调用该函数时仅返回该PDB相关信息。

参数：nan

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

pg_get_variable_info()

描述：获取共享内存变量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

pg_get_xidlimit()

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

参数：nan

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

pg_relation_compression_ratio()

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

参数：text

返回值类型：real

pg_relation_with_compression()

描述：查询表是否压缩。

参数：text

返回值类型：boolean

pg_stat_file_recursive()

描述：列出路径下所有文件。多租场景下，PDB内部禁用该函数。

参数：location text

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

pg_stat_get_activity_for_temptable()

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

参数：nan

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

pg_stat_get_activity_ng()

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

参数：pid bigint

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

pg_stat_get_cgroup_info()

描述：返回cgroup信息。

参数：nan

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

pg_stat_get_realtime_info_internal()

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

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

返回值类型：text

pg_test_err_contain_err()

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

参数：integer

返回值类型：void

get_global_user_transaction()

描述：返回所有节点上各用户的事务相关信息。多租场景下，non-PDB调用该函数时返回全部信息，PDB调用该函数时仅返回该PDB相关信息。

返回值类型：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、dbid oid

pg_collation_for()

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

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

返回值类型：text

pgxc_unlock_for_sp_database(name Name)

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

pgxc_lock_for_sp_database(name Name)

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

copy_error_log_create()

描述：由于COPY FROM容错机制所需要的错误表已变更为在初始化阶段创建的系统表，因此当前函数改为始终返回true，仅做兼容。

返回值类型：Boolean

dynamic_func_control(scope text, function_name text, action text, "{params}" text[])

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

返回值类型：record

gs_parse_page_bypath(path text, blocknum bigint, relation_type text, read_memory boolean)

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

返回值类型：text

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

正常使用示例：

# 解析BTree索引文件中所有页面的信息内容
# 函数调用前请依据参数说明中的内容确保文件路径真实存在
gaussdb=# SELECT gs_parse_page_bypath('base/16603/16394', -1, 'btree',  false);
                        gs_parse_page_bypath                        
--------------------------------------------------------------------
 gs_log_dir/dump/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                          
-----------------------------------------------------------------------
 gs_log_dir/dump/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                        
--------------------------------------------------------------------
 gs_log_dir/dump/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

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

gs_xlogdump_tablepath(path text, blocknum bigint, relation_type text)

描述：用于解析指定表页面对应的日志，并返回存放解析内容的路径。多租场景下，该函数在PDB内部禁用。

返回值类型：text

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

gs_xlogdump_parsepage_tablepath(path text, blocknum bigint, relation_type text,read_memory boolean)

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

返回值类型：text

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

gs_shared_storage_xlogdump_lsn(start_lsn text, end_lsn text, xlog_file_path text)

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

返回值类型：text

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

gs_shared_storage_ctlinfo()

描述：用于获取当前DN共享卷元数据相关信息。

返回值类型：record

gs_index_verify(oid oid, uint32 blkno)

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

返回值类型：record

gs_index_recycle_queue(Oid oid, int type, uint32 blkno)

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

返回值类型：record

gs_stat_wal_entrytable(int64 idx)

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

返回值类型：record

gs_walwriter_flush_position()

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

返回值类型：record

gs_walwriter_flush_stat(int operation)

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

返回值类型：record

gs_catalog_attribute_records()

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

参数：系统表oid

返回值类型：record

gs_comm_proxy_thread_status()

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

参数：nan

返回值类型：record

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

pg_ls_tmpdir()

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

参数：nan

返回值类型：record

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

pg_ls_tmpdir(oid)

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

参数：oid

返回值类型：record

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

pg_ls_waldir()

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

参数：nan

返回值类型：record

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

gs_stat_anti_cache()

描述：返回AntiCache的相关统计信息。

参数：nan

返回值类型：record

gs_stat_vlog_buffer()

描述：返回verifyLog buffer的相关统计信息。

参数：nan

返回值类型：record

gs_stat_vlog_related_io()

描述：返回verifylog文件读写的io相关统计信息。

参数：nan

返回值类型：record

gs_write_term_log(void)

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

返回值类型：Boolean

gs_stat_space(bool init)

描述：用于查询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并发拓页时耗时较高。

gs_index_dump_read(int8 reset, text out_type)

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

返回值类型：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)

gs_redo_upage(directory_path text, backup_path text, blocknum bigint, relation_type text, xlog_path text, lsn text)

描述：用于将备份的特定UStore数据页面重放到指定LSN，并在重放期间校验页面，若检测到页面受损则直接落盘该坏块，返回落盘路径、页面LSN以及受损信息，否则重放至指定LSN并落盘页面后返回，必须是系统管理员或运维管理员才能执行此函数。多租场景下，该函数在PDB内部禁用。

返回值类型：record

gs_xlogdump_bylastlsn(last_lsn text, blocknum bigint, relation_type text)

描述：传入一个页面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/gs_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.

gs_shared_storage_flush_stat(int operation)

描述：统计共享盘的写入数据量、写入速度、写入时间、读取数据量、读取速度、读取时间等。多租场景下，non-PDB调用该函数时正常运行，PDB调用该函数时报错。

返回值类型：record

示例：

gaussdb=# SELECT * FROM gs_shared_storage_flush_stat(1);
 stat_switch | write_times | avg_write_bytes | avg_actual_write_bytes | total_write_time | avg_write_time | avg_write_speed | avg_actual_write_speed | total_write_sleep_time | read_times | avg
_read_bytes | avg_actual_read_bytes | total_read_time | avg_read_time | avg_read_speed | avg_actual_read_speed | total_read_sleep_time |        stat_start_time        |         stat_end_time

-------------+-------------+-----------------+------------------------+------------------+----------------+-----------------+------------------------+------------------------+------------+----
------------+-----------------------+-----------------+---------------+----------------+-----------------------+-----------------------+-------------------------------+------------------------
-------
 t           |       43644 | 8624            | 8624                   |        263922553 | 6047           | 1392            | 1392                   |            26918503404 |       7451 | 140
13          | 14013                 |         5321082 | 714           | 19163          | 19163                 |                     0 | 2023-12-18 07:18:39.766855+08 | 2023-12-18 16:29:22.757
535+08
(1 row)

dbe_perf.get_full_sql_by_parent_id_and_timestamp(parent_id bigint, start_timestamp timestamp with time zone, end_timestamp timestamp with time zone)

描述：根据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)

gaussdb=# DROP PROCEDURE mypro1();
DROP PROCEDURE
gaussdb=# DROP TABLE test;
DROP TABLE

gin_clean_pending_list(index regclass)

描述：清理指定UGIN索引的“pending list”，将里面的条目批量移动到主索引页面中，返回清理的页面数量。如果索引未开启fastupdate选项，则不会发生清理，结果为0。

返回值类型：bigint

gs_stat_freespace(Oid relid, Oid partid, char type, int sample_ratio)

描述：通过统计信息或采样的方法估算表/分区表/索引的膨胀率，输出空间使用统计信息及膨胀率信息。

返回值类型：record