PG_PROC PG_PROC系统表存储函数或过程的信息。 表1 PG_PROC字段 名称 类型 描述 oid oid 行标识符（隐含字段，必须明确选择）。 proname name 函数名称。 pronamespace oid 包含该函数名称空间的OID。 proowner oid 函数的所有者。 prolang oid 这个函数的实现语言或调用接口。 procost real 估算的执行成本。 prorows real 估算的影响行的数目。 provariadic oid 参数元素的数据类型。 protransform regproc 此函数的简化调用方式。 proisagg boolean 函数是否是聚集函数。 t（true）：表示是。 f（false）：表示不是。 proiswindow boolean 函数是否是窗口函数。 t（true）：表示是。 f（false）：表示不是。 prosecdef boolean 函数是否是一个安全定义器（也就是一个“setuid”函数）。 t（true）：表示是。 f（false）：表示不是。 proleakproof boolean 函数是否没有副作用。如果函数没有对参数进行防泄露处理，则会抛出错误。 t（true）：表示没副作用。 f（false）：表示有副作用。 proisstrict boolean t（true）：使用该函数时，如果入参有空值，则函数实际上不调用直接返回空。 f（false）：使用该函数时，即使入参有空值，也要调用。所以该函数必须处理空输入。 proretset boolean 函数返回值是否为一个集合（也就是说，指定数据类型的多个数值）。 true：函数返回值是一个集合。 false：函数返回值不是一个集合。 provolatile "char" 该函数的结果是否只依赖于它的输入参数，或者还会被外界因素影响。 i：“不可变的”（immutable）函数，对于相同的输入总是产生相同的结果。 s：“稳定的”（stable）函数，（对于固定输入）其结果在一次扫描里不变。 v：“易变”（volatile）函数，其结果可能在任何时候变化v也用于那些有副作用的函数，因此调用它们无法得到优化。 pronargs smallint 参数数目。 pronargdefaults smallint 有默认值的参数数目。 prorettype oid 返回值的数据类型。 proargtypes oidvector 一个存放函数参数的数据类型的数组。数组里只包括输入参数（包括INOUT参数），代表该函数的调用签名（接口）。 proallargtypes oid[] 一个包含函数参数的数据类型的数组。数组里包括所有参数的类型（包括OUT和INOUT参数），如果所有参数都是IN参数，则这个字段就会是空。请注意数组下标是以1为起点的，而因为历史原因，proargtypes的下标起点为0。 proargmodes "char"[] 一个保存函数参数模式的数组，编码如下： i：表示IN参数。 o：表示OUT参数。 b：表示INOUT参数。 v：表示VARIADIC参数。 如果所有参数都是IN参数，则这个字段为空。请注意，下标对应的是proallargtypes的位置，而不是proargtypes。 proargnames text[] 一个保存函数参数的名称的数组。没有名称的参数在数组里设置为空字符串。如果没有一个参数有名称，这个字段将是空。请注意，此数组的下标对应proallargtypes而不是proargtypes。 proargdefaults pg_node_tree 默认值的表达式树。是PRONARGDEFAULTS元素的列表。 prosrc text 描述函数或存储过程的定义。例如，对于解释型语言来说就是函数的源程序，或者一个链接符号，一个文件名，或者函数和存储过程创建时指定的其他任何函数体内容，具体取决于语言/调用习惯的实现。 probin text 关于如何调用该函数的附加信息。同样，其含义也是和语言相关的。 proconfig text[] 函数针对运行时配置变量的本地设置。 proacl aclitem[] 访问权限。具体请参见GRANT和REVOKE。 prodefaultargpos int2vector 函数具有默认值的入参的位置。 fencedmode boolean 函数的执行模式，表示函数是在fence还是not fence模式下执行。 true：fence模式，函数的执行会在重新fork的进程中执行。 false：not fence模式。 系统内建函数，fencedmode字段均为false，即 not fence模式。 proshippable boolean 表示该函数是否可以下推到DN上执行，默认值是false。 对于IMMUTABLE类型的函数，函数始终可以下推到DN上执行。 对于STABLE/VOLATILE类型的函数，仅当函数的属性是SHIPPABLE的时候，函数可以下推到DN执行。 propackage boolean 表示该函数是否支持重载，默认值是false。 t（true）：表示支持。 f（false）：表示不支持。 prokind "char" 表示该对象为函数还是存储过程。 'f'：表示该对象为函数。 'p'：表示该对象为存储过程。 proargsrc text 描述兼容ORA语法定义的函数或存储过程的参数输入字符串，包括参数注释。默认值为NULL。 proargtypesext oidvector_extend 当函数参数较多时，用来存放函数参数的数据类型的数组。数组里只包括输入参数（包括INOUT参数），代表该函数的调用签名（接口）。 prodefaultargposext int2vector_extend 当函数参数较多时，函数具有默认值的入参的位置。 allargtypes oidvector 用来存放存储过程参数的数据类型的数组，包含存储过程所有参数（入参、出参、INOUT参数）。 allargtypesext oidvector_extend 当函数参数较多（大于666个）时，用来存放存储过程参数的数据类型的数组，包含所有参数（入参、出参、INOUT参数）。 新建函数时，会向pg_proc表中插入数据，更新索引。当出入参个数很多时，索引的长度可能会超过页面的三分之一，进而可能会产生“Index row size xxx exceeds maximum xxx for index "pg_proc_proname_all_args_nsp_index"”的报错，此为预期情况。您可以通过减少参数个数，避免该报错的产生。 父主题： 其他系统表

语法格式 收集表的统计信息。 { ANALYZE | ANALYSE } [ VERBOSE ] [ table_name [ ( column_name [, ...] ) ] ] [ WITH PARTITION_MODE ]; 收集分区表的分区统计信息。 { ANALYZE | ANALYSE } [ VERBOSE ] table_name [ ( column_name [, ...] ) ] PARTITION ( partition_name ) ; 使用关键字PARTITION，partition_name必须为一级分区名字。 分布式不支持二级分区。

参数说明 VERBOSE 启用显示进度信息。 如果指定了VERBOSE，ANALYZE发出进度信息，表明目前正在处理的表。各种有关表的统计信息也会打印出来。 table_name 需要分析的特定表的表名（可能会带模式名），如果省略，将对数据库中的所有表（非外部表）进行分析。 对于ANALYZE收集统计信息，目前仅支持行存表的外表。 取值范围：已有的表名。 column_name，column_1_name，column_2_name 需要分析特定列的列名，默认为所有列。 取值范围：已有的列名。 partition_name 如果table为分区表，在关键字PARTITION后面指定分区名partition_name表示分析该分区表的统计信息。 取值范围：表的某一个分区名。 index_name 需要分析的特定索引表的表名（可能会带模式名）。 取值范围：已有的表名。 FAST|COMPLETE FAST模式下主要对于表的CRC和page header进行校验，如果校验失败则会告警；而COMPLETE模式下，则主要对表的指针、tuple进行解析校验。 CASCADE CASCADE模式下会对当前表的所有索引进行检测处理。 PARTITION_MODE PARTITION_MODE适用于分区表级联收集统计信息，可选项和含义如下表所示。不适用于非分区表。 表1 PARTITION_MODE选项说明 PARTITION_MODE选项 含义 ALL 收集整表、一级分区的统计信息。 GLOBAL 收集整表的统计信息。 PARTITION 收集一级分区的统计信息。 GLOBAL AND PARTITION 收集整表、一级分区的统计信息。 ALL COMPLETE 收集整表、一级分区的统计信息。 AUTO 缺省值，以statistic_granularity或default_statistic_granularity中配置的参数为准，其中表级参数statistic_granularity的优先级高于全局参数default_statistic_granularity。 其中，ALL和ALL COMPLETE的区别为：ALL_COMPLETE模式下，采用更高的采样率，相应地，计算统计信息的耗时会更长。 从505.0.0之前版本升级到505.0.0及更高版本时，在升级观察期期间，PARTITION_MODE不生效，其行为与升级前版本保持一致。 analyze整库时，不支持指定partition mode，即不支持analyze with global等语法。 analyze整库时，支持设置default_statistic_granularity为GLOBAL或ALL，此时analyze行为和default_statistic_granularity的定义相同；当default_statistic_granularity设置为其他值时，analyze行为退化为GLOBAL行为。

示例 收集表的的统计信息。 --创建customer_info表。 gaussdb=# CREATE TABLE customer_info( wr_returned_date_sk INTEGER , wr_returned_time_sk INTEGER , wr_item_sk INTEGER NOT NULL ,wr_refunded_customer_sk INTEGER ) DISTRIBUTE BY HASH (wr_item_sk); --使用ANALYZE语句更新统计信息。 gaussdb=# ANALYZE customer_info; --使用ANALYZE VERBOSE语句更新统计信息，并输出customer_info表的相关信息。 gaussdb=# ANALYZE VERBOSE customer_info; INFO: analyzing "public.customer_info"(cn_5002 pid=53078) --使用ANALYZE VERBOSE输出customer_info表的wr_returned_time_sk列信息。 gaussdb=# ANALYZE VERBOSE customer_info(wr_returned_time_sk); INFO: analyzing "public.customer_info"(cn_5002 pid=53078) 收集分区表的统计信息。 --创建分区表。 gaussdb=# CREATE TABLE customer_par( wr_returned_date_sk INTEGER , wr_returned_time_sk INTEGER , wr_item_sk INTEGER NOT NULL, wr_returned_customer_sk INTEGER) DISTRIBUTE BY HASH (wr_item_sk)PARTITION BY RANGE(wr_returned_date_sk)(PARTITION P1 VALUES LESS THAN(2452275),PARTITION P2 VALUES LESS THAN(2452640),PARTITION P3 VALUES LESS THAN(2453000),PARTITION P4 VALUES LESS THAN(MAXVALUE))ENABLE ROW MOVEMENT; --使用ANALYZE语句更新统计信息。 gaussdb=# ANALYZE customer_par; --使用ANALYZE VERBOSE输出customer_par表的相关信息。 gaussdb=# ANALYZE VERBOSE customer_par; INFO: analyzing "public.customer_par"(cn_5001 pid=446617) --使用ANALYZE VERBOSE输出P1一级分区表的相关信息。 gaussdb=# ANALYZE VERBOSE customer_par PARTITION(P1); INFO: analyzing "public.customer_par"(cn_5001 pid=446617) 手动收集多列统计信息。 --手动收集wr_returned_date_sk、wr_returned_time_sk这两列的统计信息。 gaussdb=# ANALYZE VERBOSE customer_info (wr_returned_date_sk,wr_returned_time_sk); INFO: analyzing "public.customer_par"(cn_5001 pid=446617) 自动收集多列统计信息。 --给customer_info表创建索引。 gaussdb=# CREATE INDEX customer_index ON customer_info USING btree(wr_returned_date_sk,wr_returned_time_sk,wr_item_sk,wr_refunded_customer_sk); --设置auto_statistic_ext_columns参数为4。 gaussdb=# set auto_statistic_ext_columns=4; --自动收集多列统计信息。 gaussdb=# ANALYZE VERBOSE customer_info; INFO: analyzing "public.customer_info"(cn_5001 pid=446617) 检测当前库的数据文件。 gaussdb=# ANALYZE VERIFY FAST; 检测表和索引的数据文件。 --检查customer_info表。 gaussdb=# ANALYZE VERIFY FAST customer_info; --检查customer_index索引。 gaussdb=# ANALYZE VERIFY FAST customer_index; 检测表分区的数据文件。 --检查customer_par分区表中的P1分区。 gaussdb=# ANALYZE VERIFY FAST customer_par PARTITION (P1); 删除数据。 --删除索引customer_index。 gaussdb=# DROP INDEX customer_index; --删除表customer_info。 gaussdb=# DROP TABLE customer_info; --删除分区表customer_par。 gaussdb=# DROP TABLE customer_par;

功能描述 用于收集与数据库中普通表内容相关的统计信息，统计结果存储在系统表PG_STATISTIC、PG_STATISTIC_EXT下，执行ANALYZE命令后，可在上述系统表中查询收集到的统计信息，也可以通过系统视图PG_STATS、PG_EXT_STATS查询信息。执行计划生成器会使用这些统计数据，以确定最有效的执行计划。 如果没有指定参数，ANALYZE会分析当前数据库中的每个表和分区表。同时也可以通过指定table_name、column_name和partition_name参数把分析限定在特定的表、列或分区表中。 {ANALYZE|ANALYSE} VERIFY用于检测数据库中普通表的数据文件是否损坏。 每次收集的统计信息，都会存入统计信息历史表（GS_STATISTIC_EXT_HISTORY、GS_STATISTIC_HISTORY、GS_TABLESTATS_HISTORY）中，历史表存放的数量和统计信息的保留时间由GUC参数stats_history_record_limit和stats_history_retention_time控制。

注意事项 ANALYZE非临时表不支持在一个匿名块、事务块、函数或存储过程内被执行。ANALYZE临时表支持存储过程中被执行，不支持统计信息回滚操作。 ANALYZE VERIFY如果不涉及远程读场景，远程读参数则不会生效。对于检测出关键系统表页面损坏的错误，将直接报错不再继续检测。 如果ANALYZE不指定参数，则默认处理当前用户拥有相应权限的表。如果参数指定了一个表参数，ANALYZE只处理指定的表。 要对一个表进行ANALYZE操作，用户必须是表的所有者或者被授予了指定表VACUUM权限，三权分立开关关闭时，默认系统管理员有该权限。数据库的所有者允许对数据库中除了共享目录以外的所有表进行ANALYZE操作（该限制意味着只有系统管理员才能真正对一个数据库进行ANALYZE操作）。ANALYZE会跳过那些用户没有权限的表。 ANALYZE不收集无法做比较或等值运算的列，例如：CURSOR类型。

enable_partrouting_optimization 参数说明：控制是否支持分区表插入优化。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 on表示支持分区表插入优化，针对inert select语句，当select包含常量分区键时，insert只需要做一次分区路由，提升性能。 off表示不支持分区表插入优化，插入每一条数据前都需要做一次分区路由去确定插入哪一张分区表。 默认值：on 分区表插入优化约束： 只支持Insert select语句。 insert into ta select from tb中，插入a表中所有分区键的值，对应select结果集中的列值必须是常量（可以不存在该列，因为默认值也是恒定的）。 insert into ta select c,d from b where tb.c='1'或select '1' as c, d from tb则可以判断结果列tb.c为常量。 insert into ta select c,d from b where tb.c=func('1'); 如果func()不是volatile函数，也不是包含非常量参数的stable/immutable函数，则可以判断tb.c为常量。 如果列值为聚合函数的返回值，如：insert into ta select count(c),d from b where tb.c='1' group by c, d; 不能判断count(c)为常量。 不支持upsert子句。 不支持包含before和instead触发器的表，因为可能改变要插入的数据。

enable_default_ustore_table 参数说明：指定是否开启默认支持Ustore存储引擎，该参数为on时，创建的表类型都为Ustore表。 参数类型：布尔型 取值范围： on表示开启默认支持Ustore存储引擎。 off表示不开启默认支持Ustore存储引擎。 默认值：on 设置方式：该参数属于USERSET类型，请参考表1中对应设置方法进行设置。特别需要注意，使用Ustore表，必须要开启track_counts和track_activities参数，否则会引起空间膨胀。升级场景下该参数的默认值会优先保证兼容性，即升级后的默认值与老版本的取值一致。

max_concurrent_autonomous_transactions 参数说明：自治事务最大连接数，同一时间自治事务执行的最大并发数。当设置为0时，将无法执行自治事务。 参数类型：整型 参数单位：无 取值范围：0~10000，理论最大值为10000，实际最大值为动态值，计算公式为“262143 - job_queue_processes - autovacuum_max_workers - max_inner_tool_connections - max_connections - AUXILIARY_BACKENDS - AV_LAUNCHER_PRO CS ”，job_queue_processes、autovacuum_max_workers、max_inner_tool_connections和max_connections的值取决于对应GUC参数的设置，AUXILIARY_BACKENDS为预留辅助线程数固定为20，AV_LAUNCHER_PROCS为预留autovacuum的launcher线程数固定为2。 默认值： 独立部署：80（60核CPU/480G内存）；40（32核CPU/256G内存）；20（16核CPU/128G内存）；10（8核CPU/64G内存，4核CPU/32G内存，4核CPU/16G内存） 设置方式：该参数属于POSTMASTER类型参数，请参考表表1中对应设置方法进行设置。 设置建议：根据实际业务需要和硬件配置设置此参数，建议不超过max_connections的1/10。若仅调大此参数，未同比例调整内存参数，业务压力大时，容易出现内存不足，报错提示“memory is temporarily unavailable”。 若升级过程中涉及此参数范围变更，并且在commit前修改了此参数，则如果执行升级回滚，需要将此参数调整至升级前允许的范围，否则可能导致数据库无法启动。

enable_gpi_auto_update 参数说明：控制在分区DDL命令中是否默认更新Global索引。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。该参数必须在CN和DN设置为相同值，否则可能会导致Global索引功能异常。 取值范围：布尔型 on表示默认更新Global索引，此时分区DDL无论带不带UPDATE GLOBAL INDEX子句，都会更新Global索引。 off表示默认不更新Global索引，此时只有当分区DDL带UPDATE GLOBAL INDEX子句，才会更新Global索引。 默认值：off

change_cluster_mode 参数说明：用于表示集群是否处于模式切换过程中，其中“模式切换”是指：一主两备集群切换为一主一备一日志集群，或一主一备一日志集群切换为一主两备集群，或一主一备一日志集群中备DN和日志DN互切。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，0~2147483647 0表示不处于集群模式切换过程中。 1表示处于集群模式切换过程中。 其他值无实际意义，效果等同于设置为0。 默认值：0 该参数用于控制“分布式备机读”功能是否正常可用。当设置为1时，“分布式备机读”功能将无法使用，请谨慎设置该参数。

enable_segment_datafile_preallocate 参数说明：指定是否开启段页式文件扩展时立即分配磁盘空间模式。该参数为on时，表示文件扩展时优先使用fallocate立即分配磁盘空间，如果系统不支持fallocate，则使用逐字节写零方式申请磁盘空间；该参数为off时，表示文件扩展时不立即分配磁盘空间，文件以空洞方式增长。该参数属于SIGHUP类型，请参见表1中对应设置方法进行设置。 取值范围：[off,on] 默认值：on

恢复控制函数 恢复信息函数提供了当前备机状态的信息。这些函数可能在恢复期间或正常运行中执行。 pg_is_in_recovery() 描述：如果恢复仍然在进行中则返回true。 返回值类型：Boolean 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。 返回值类型：Boolean pg_xlog_replay_pause() 描述：立即暂停恢复。 返回值类型：void pg_xlog_replay_resume() 描述：如果恢复处于暂停状态，则重新启动。 返回值类型：void gs_get_active_archiving_standby() 描述：查询同一分片内归档备机的信息。返回备机名，备机归档位置和已归档日志个数。 返回值类型：text，int gs_pitr_get_warning_for_xlog_force_recycle() 描述：查询开启归档后是否因归档槽不推进日志大量堆积导致日志被回收。 返回值类型：Boolean 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 gs_recent_barrier_buffer_info(start_time text, end_time text) 描述：根据用户输入的时间范围，进行相应的barrier信息查询，获取time_stamp、CSN、LSN和standard_time。 返回值类型：records 说明：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限。输入参数start_time和end_time采用“年-月-日 时间”格式，其中时间采用clock格式。查询最大时间跨度为1天，超出跨度约束，根据查询起始时间将结束时间自动转换为极限边界进行查询。例如： gaussdb=# SELECT * FROM gs_recent_barrier_buffer_info('2024-01-15 23:27:50', '2024-01-15 23:28:00'); timestamp | lsn | csn | standard_time ------------+-------------------+----------+--------------------- 1705332470 | 00000000/15FFBBA0 | 41020421 | 2024-01-15 23:27:50 1705332471 | 00000000/15FFBDF0 | 41020422 | 2024-01-15 23:27:51 1705332472 | 00000000/15FFC058 | 41020423 | 2024-01-15 23:27:52 1705332472 | 00000000/15FFC0F8 | 41020424 | 2024-01-15 23:27:52 1705332473 | 00000000/15FFC348 | 41020425 | 2024-01-15 23:27:53 1705332474 | 00000000/15FFC598 | 41020426 | 2024-01-15 23:27:54 1705332475 | 00000000/15FFC638 | 41020427 | 2024-01-15 23:27:55 1705332476 | 00000000/15FFC888 | 41020428 | 2024-01-15 23:27:56 1705332476 | 00000000/15FFDC80 | 41020433 | 2024-01-15 23:27:56 1705332477 | 00000000/15FFDD20 | 41020434 | 2024-01-15 23:27:57 1705332478 | 00000000/15FFDF70 | 41020435 | 2024-01-15 23:27:58 1705332479 | 00000000/15FFE1D8 | 41020436 | 2024-01-15 23:27:59 1705332480 | 00000000/15FFE278 | 41020437 | 2024-01-15 23:28:00 1705332480 | 00000000/15FFE4C8 | 41020438 | 2024-01-15 23:28:00 (14 rows) gs_show_obs_media_files(slot_name cstring, src cstring, offset int32, limit int32) 描述：根据用户输入的归档槽（slot_name）和OBS目录地址（src），查询OBS文件列表。 返回值类型：records 说明：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限。Offset为查询结果偏移，limit为输出最大行数，查询src下所有文件。例如： gaussdb=# SELECT gs_show_obs_archive_files('ssh','cn_5001/pg_xlog',1, 5); gs_show_obs_archive_files ------------------------------------------------------------------------------------------------- (wstdist_ssh/archive/cn_5001/pg_xlog/000000010000000000000010_01_01_00000000_00000000_00000003) (wstdist_ssh/archive/cn_5001/pg_xlog/000000010000000000000010_02_01_00000000_00000000_00000003) (wstdist_ssh/archive/cn_5001/pg_xlog/000000010000000000000010_03_01_00000000_00000000_00000003) (wstdist_ssh/archive/cn_5001/pg_xlog/000000010000000000000011_00_01_00000000_00000000_00000003) (wstdist_ssh/archive/cn_5001/pg_xlog/000000010000000000000011_01_01_00000000_00000000_00000003) (5 rows) gs_upload_obs_media_file(slot_name cstring, src cstring, dest cstring, is_forced bool) 描述：根据用户输入的归档槽（slot_name）、上传文件原地址（src）、OBS地址（dest）和是否强制上传（is_forced），上传OBS文件。 返回值类型：void 说明：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限。原文件目录仅允许为$GAUSS LOG 目录。例如： gaussdb=# SELECT * FROM gs_upload_obs_archive_file('ssh', '/data/gauss/log/stwang/test/000000010000000000000019_02_01_00000000_00000000_00000003', 'cn_5001/pg_xlog/000000010000000000000019_02_01_00000000_00000000_00000003', true); gs_upload_obs_archive_file ---------------------------- (1 row) gs_download_obs_media_file(slot_name cstring, src cstring, dest cstring) 描述：根据用户输入的归档槽（slot_name）、下载原地址（src）和本地目标地址（dest），下载OBS文件。 返回值类型：void 说明：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限。下载目录仅允许为$GAUSSLOG目录。例如： gaussdb=# SELECT * FROM gs_download_obs_archive_file('ssh','cn_5001/pg_xlog/000000010000000000000019_02_01_00000000_00000000_00000003','/data/gauss/log/stwang/test'); gs_download_obs_archive_file ------------------------------ (1 row) 当恢复暂停时，没有发生数据库更改。如果是在热备里，所有新的查询将看到一致的数据库快照，并且不会有进一步的查询冲突产生，直到恢复继续。 如果不能使用流复制，则暂停状态将无限的延续。当流复制正在进行时，将连续接收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 [, fast boolean ]) 描述：开始执行在线备份（需要管理员角色、复制的角色或运维管理员角色打开operation_mode）。以gs_roach开头的label串为保留命名串，只能由内部备份工具GaussRoach使用。 返回值类型：text 备注：pg_start_backup接受一个用户定义的备份标签（通常这是备份转储文件存放地点的名称）。这个函数向数据库集群的数据目录写入一个备份标签文件，然后以文本方式返回备份的事务日志起始位置。该函数务必配合pg_stop_backup()使用，单独调用该函数会导致backup_label残留，后面再进行WAL回放时会根据backup_label读取checkpoint，如果该checkpoint对应的WAL文件已经被回收，则会导致数据库无法正常启动。 1 2 3 4 5 gaussdb=# SELECT pg_start_backup('label_goes_here',true); pg_start_backup ----------------- 0/3000020 (1 row) pg_stop_backup() 描述：完成执行在线备份。需要管理员角色、复制的角色执行或运维管理员角色打开operation_mode。 返回值类型：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从前述函数的返回结果中抽取相应的事务日志文件名称和字节偏移量。例如： 1 2 3 4 5 6 7 gaussdb=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup()); NOTICE: pg_stop_backup cleanup done, waiting for required WAL segments to be archived NOTICE: 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_start_tracked_location() 描述：用于查询cbm解析的起始lsn位置。 返回值类型：text 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 此次操作的标识。 取值范围：字符串，不支持除大小写字母、数字以及下划线(_)以外的字符。 返回值类型：Boolean 备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operation_mode。 gs_is_dw_io_blocked() 描述：查看当前双写页面刷盘是否被阻塞，如果处于阻塞中则返回true。 返回值类型：Boolean 备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operation_mode。 gs_pitr_advance_last_updated_barrier() 描述：在PITR模式下，强制推进上次上传到OBS/NAS介质中的全局最大已归档恢复点到当前点，无入参。 返回值类型：text 备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operation_mode。同时只能在分布式的第一个normal CN上使用才有效。返回值为当前推进到的最新本地最大已归档恢复点。 gs_pitr_clean_local_barrier_files('delete_timestamp') 描述：清理本地缓存的barrier记录文件。 参数范围：delete_timestamp参数类型为text，为linux时间戳，长度为10位。 返回值类型：text 备注：调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operation_mode。返回的结果是删除后本地最老barrier文件的开始时间戳。 gs_get_barrier_lsn(barrier_name text) 描述：获取备份创建的barrier对应的lsn。 返回值类型：text 备注：当前入参仅支持gs_roach_full和gs_roach_inc。调用该函数的用户需要具有SYSADMIN权限或具有OPRADMIN权限，运维管理员角色须打开operation_mode。 gs_gbr_relation_associated_filenode(schemaName name, tableName name) 描述：返回与输入table相关的全部索引、sequence、分区、toast、toast index的relfilenode。 返回值类型：records 备注：gs_gbr_relation_associated_filenode返回的字段包含文件类型relkind、文件所在namespace、文件对应的relation name、文件所在的database oid、文件所在的tablespace oid以及文件的relfilenode。 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是预留参数。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为归档的路径，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归档槽： 1 2 3 4 5 gaussdb=# SELECT * FROM pg_create_physical_replication_slot_extern('uuid', false, 'OBS;obs.cn-north-7.ulanqab.huawei.com;dyk;19D772JBCACXX3KWS51D;********;gaussdb_uuid/dn1;0;0', false); slotname | xlog_position ----------+--------------- uuid | (1 row) 创建NAS归档槽： 1 2 3 4 gaussdb=# SELECT * FROM pg_create_physical_replication_slot_extern('uuid', false, 'NAS;/data/nas/media/gaussdb_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删除是否成功，该值都会正常返回。 gaussdb=# SELECT gs_set_obs_delete_location('0/54000000'); gs_set_obs_delete_location ----------------------------- 000000010000000000000054_00 (1 row) gs_set_obs_delete_location_with_slotname(cstring, cstring ) 描述：设置指定归档槽obs归档日志可删除的位置。第一个参数实际为Log Sequence Number ( LSN )，该位置之前的日志已经完成回放并且落盘，可以在obs上进行删除，第二个参数为归档槽的名称。 返回值类型：xlog_file_name text，表明此次可删除点所在的日志文件名。无论obs删除是否成功，该值都会正常返回。 gs_get_global_barrier_status() 描述：gs_get_global_barrier_status用以查询已在obs完成归档的最新global barrier。 返回值类型：text global_barrier_id：全局最新barrier ID。 global_achive_barrier_id：全局最新归档barrier ID。 gs_get_global_barriers_status() 描述：gs_get_global_barriers_status用以查询已在obs完成归档的最新global barrier。 返回值类型：text slot_name：槽位名。 global_barrier_id：全局最新barrier ID。 global_achive_barrier_id：全局最新归档barrier ID。

enable_segment_remain_cleanup 参数说明：该参数用来控制启用哪种段页式残留清理方式。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔值。 on：表示启用旧式段页式残留清理机制。 查询接口：gs_stat_remain_segment_info，gs_local_stat_remain_segment_info。 清理接口：gs_free_remain_segment，gs_local_free_remain_segment。 off：表示启用新式段页式残留清理机制。 查询接口：GS_SEG_SPC_REMAIN_SEGMENTS，GS_SEG_SPC_REMAIN_EXTENTS。 清理接口：gs_seg_free_spc_remain_segment，gs_seg_free_spc_remain_extent。 请避免随意切换清理方式，否则可能会出现无法正常清理段页式残留或其他异常。 默认值：off