华为云用户手册

nls_nchar_characterset 参数说明：搭配nchr(cvalue int|bigint)系统函数使用，设置国家字符集。该参数可在PDB级别设置。 参数类型：字符串 参数单位：无 取值范围：“AL16UTF16”、“UTF8”，不区分大小写。 默认值："AL16UTF16"。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改，避免出现意料之外的结果。 数据库不支持国家字符集，该参数只是为了兼容A数据库，获取用户想使用的国家字符集。 该GUC参数仅限于nchr(cvalue int|bigint)函数的使用。

transform_null_equals 参数说明：是否控制表达式expr=NULL（或NULL=expr）当作expr IS NULL处理。正确的SQL标准兼容的expr=NULL总是返回NULL（未知）。Microsoft Access里的过滤表单生成的查询使用expr=NULL来测试空值。打开这个选项后，可以使用该接口来访问数据库。该参数可在PDB级别设置。 参数类型：布尔型 参数单位：无 取值范围： on：表示控制表达式expr=NULL（或NULL=expr）当作expr IS NULL处理，如果expr得出NULL值则返回真，否则返回假。 off：表示不控制，即expr=NULL总是返回NULL（未知）。 默认值：off。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改，避免出现意料之外的结果。 新用户经常在涉及NULL的表达式上语义混淆，故默认值设为off。

support_extended_features 参数说明：控制是否支持数据库的扩展特性。 参数类型：布尔型 参数单位：无 取值范围： on：表示支持数据库的扩展特性。 off：表示不支持数据库的扩展特性。 默认值：off 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改，避免出现意料之外的结果。

a_format_date_timestamp 参数说明：控制返回的日期时间。在A模式下，当事务开启时，函数current_date()、current_timestamp()、localtimestamp()返回当前SQL启动的时间戳。多租场景下，该参数可在PDB级别设置。 参数类型：布尔型 参数单位：无 取值范围： on：返回当前SQL启动的时间戳。 off：返回事务开启的日期或日期及时间。 默认值：off。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。在开启事务需要返回系统时间时可开启该参数。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改，避免出现意料之外的结果。

partition_lock_upgrade_timeout 参数说明：在执行某些查询语句的过程中，需要将分区表上的锁级别由允许读的ExclusiveLock级别升级到读写阻塞的AccessExclusiveLock级别。如果此时已经存在并发的读事务，那么该锁升级操作将阻塞等待。partition_lock_upgrade_timeout为尝试锁升级的等待超时时间。该参数可在PDB级别设置。 举例：在分区表上进行MERGE PARTITION和CLUSTER PARTITION操作时，都利用了临时表进行数据重排和文件交换，为了最大程度提高分区上的操作并发度，在数据重排阶段给相关分区加锁ExclusiveLock，在文件交换阶段加锁AccessExclusiveLock。加锁方式是尝试性加锁，加锁成功了则立即返回，不成功则等待50ms后继续下次尝试，加锁超时时间使用会话级设置参数partition_lock_upgrade_timeout。 参数类型：整型 参数单位：s（秒） 取值范围：-1 ~ 3000。-1表示无限等待，即不停地尝试锁升级，直到加锁成功。 默认值：1800。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：设置为-1时，长时间无法升级锁可能导致业务阻塞。

enable_online_ddl_waitlock 参数说明：控制DDL是否会阻塞等待pg_advisory_lock等数据库锁。 参数类型：布尔型 参数单位：无 取值范围： on：表示开启。 off：表示关闭。 默认值：off 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：主要用于OM在线操作场景，不建议用户设置。 设置不当的风险与影响：修改该参数取值可能导致数据库出现意料之外的结果，请保持默认值。

num_internal_lock_partitions 参数说明：控制内部轻量级锁分区的个数。主要用于各类场景的性能调优。 参数内容以关键字和数字的KV方式组织，各个不同类型锁之间以逗号隔开。 先后顺序对设置结果不影响。例如"C LOG _PART=256, CS NLOG_PART=512"等同于"CSNLOG_PART=512,CLOG_PART=256"。 重复设置同一关键字时，以最后一次设置为准。例如"CLOG_PART=256,CLOG_PART=2"，设置的结果为CLOG_PART=2。 参数类型：字符串 参数单位：无 取值范围： CLOG_PART：CLOG文件控制器的个数。最小值为1，最大值为256。 CSNLOG_PART：CSNLOG文件控制器的个数。最小值为1，最大值为512。 LOG2_LOCKTABLE_PART：常规锁表锁分区个数的2对数。最小值4，即锁分区数为16；最大值为16，即锁分区数为65536。 FASTPATH_PART：每个线程可以不通过主锁表拿锁的最大锁个数。最小值为20，最大值为10000。 默认值： "CLOG_PART=256,CSNLOG_PART=512,LOG2_LOCKTABLE_PART=4,FASTPATH_PART=20"（196核CPU/1536G内存，128核CPU/1024G内存，104核CPU/1024G内存，96核CPU/1024G内存，96核CPU/768G内存，80核CPU/640G内存，64核CPU/512G内存，60核CPU/480G内存，32核CPU/256G内存，16核CPU/128G内存，8核CPU/64G内存，4核CPU/32G内存）；"CLOG_PART=8,CSNLOG_PART=16,LOG2_LOCKTABLE_PART=4,FASTPATH_PART=20"（4核CPU/16G内存）。 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议： CLOG_PART：增大该值可以提高CLOG日志写入效率，提升事务提交性能，但是会增大内存使用；减小该值会减少相应内存使用，但可能使得CLOG日志写入冲突变大，影响性能。 CSNLOG_PART：增大该值可以提高CSNLOG日志写入效率，提升事务提交性能，但是会增大内存使用；减小该值会减少相应内存使用，但可能使得CSNLOG日志写入冲突变大，影响性能。 LOG2_LOCKTABLE_PART：增大该值可以提升正常流程常规锁获取锁的并行度，但是会增大内存使用，对于等待事件在LockMgrLock时，可以调大该锁增加性能。 FASTPATH_PART：对于分区表读取、更新、插入、删除操作且等待事件在LockMgrLock时，可以通过调大该值避免获取LockMgrLock提升性能，建议调整数量大于等于分区数*（1+本地索引数量）+全局索引数量+10，调大该值可能增加锁转移和锁消除时的耗时，并会额外增加内存。fastpath增量内存=((fastpath增加量/20)*8 + fastpath增加量*12) * 线程池大小，单位是字节。 设置不当的风险与影响：设置不当可能会影响数据库性能。

enable_wait_exclusive_lock 参数说明：控制ProcArrayLock的排他锁hang死检测与治愈功能的开关。 参数类型：布尔型 参数单位：无 取值范围： on：表示开启。 off：表示关闭。 默认值：on 设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改，避免出现意料之外的结果。

barrier_lock_timeout 参数说明：持有barrier锁的超时时间。该参数可在PDB级别设置。 参数类型：整型 参数单位：s（秒） 取值范围：0 ~ 3600 默认值：30。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改，避免出现意料之外的结果。

gs_clean_timeout 参数说明：控制主节点调用gs_clean工具的周期，可用来定时清理临时表。数据库连接异常中止时，通常会有临时表残留，此时需要对数据库中的临时表进行清理。 参数类型：整型 参数单位：s（秒） 取值范围：0 ~ 2147483 默认值：60 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。例如：不带单位取值1，表示gs_clean_timeout为1s；带单位取值1min，表示gs_clean_timeout为1min。取值如果要带单位，必须为s、min、h、d。 设置建议：推荐使用默认值。 设置不当的风险与影响：设置过大时，会使数据库残留临时表清理周期延长。

xloginsert_locks 参数说明：控制用于并发写预写式日志锁的个数。主要用于提高写预写式日志的效率。 参数类型：整型 参数单位：无 取值范围：1 ~ 1000。若CPU为NUMA架构，数值必须为NUMA节点数量的整数倍。 默认值：16 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：ARM CPU架构在并发压力大的场景下，可能因为原子操作的竞争而导致概率性的性能抖动，可以适当降低该参数值而获取相对稳定的运行性能。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改，避免出现意料之外的结果。

max_pred_locks_per_transaction 参数说明：当数据库连接数达到最大时，每个事务能够持有断定锁的平均数量。 这个参数并不严格限制每个事务最多可以持有多少断定锁。如果连接数没有达到最大值max_connections，那么每个事务能够持有断定锁的平均数量会增大。 参数类型：整型 参数单位：无 取值范围：10 ~ 2147483647 默认值：64 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议： 共享的断定锁表的大小是以假设任意时刻最多只有max_pred_locks_per_transaction*(max_connections+max_prepared_transactions) 个独立的对象需要被锁住为基础进行计算的。不超过设定数量的多个对象可以在任一时刻同时被锁定。当在一个事务里面修改很多不同的表时，可能需要提高这个默认数值。只能在服务器启动的时候设置。 增大这个参数可能导致 GaussDB 请求更多的System V共享内存，有可能超过操作系统的缺省配置。 设置不当的风险与影响：设置过大时，可能导致数据库启动失败。

update_lockwait_timeout 参数说明：在业务允许并发更新的情况下，该参数控制并发更新同一行时单个锁的最长等待时间。当申请的锁等待时间超过设定值时，系统会报错。该参数仅针对常规锁生效。该参数可在PDB级别设置。 参数类型：整型 参数单位：ms（毫秒） 取值范围：0 ~ 2147483647 默认值：120000（2min）。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。例如，不带单位取值900，表示update_lockwait_timeout为900ms；带单位取值2min，表示update_lockwait_timeout为2min。取值如果要带单位，必须为ms、s、min、h、d。 设置建议：设置值主要取决于并发更新同一行的事务的workload。一般TP业务，执行时间较短小于两分钟，因此等待并发更新事务提交时间较短，按默认值2min的配置误报锁超时概率较小；如果业务出现大量并发更新同一行事务，执行时间超过两分钟，可以调大该参数避免等锁超时误报。 设置不当的风险与影响：设置过大时，并发更新同一行时锁冲突造成的阻塞时间更长；设置过小时，可能会出现更多的锁超时报错。

deadlock_timeout 参数说明：设置死锁超时检测时间。当申请的锁超过设定值时，系统会检查是否产生了死锁。该参数仅针对常规锁生效。该参数可在PDB级别设置。 参数类型：整型 参数单位：ms（毫秒） 取值范围：1 ~ 2147483647 默认值：1000（即1s）。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。 设置建议： 死锁的检查代价是比较高的，服务器不会在每次等待锁的时候都运行这个过程。在系统运行过程中，不经常出现死锁情况，因此在检查死锁前只需等待一个相对较短的时间。deadlock_timeout增加，可以减少死锁检查浪费的时间，但是会减慢真正的死锁错误报告的速度。在负载过重的服务器上，用户可能需要增大deadlock_timeout。这个值的设置应该超过事务持续时间，这样可以减少在锁释放之前就开始死锁检查的问题。 当设置log_lock_waits为on时，deadlock_timeout决定一个等待时间来将查询执行过程中的锁等待耗时信息写入日志。如果要研究锁延时情况，可以设置deadlock_timeout值比正常情况小。 设置不当的风险与影响：设置过大时，会减慢死锁错误报告的速度；设置过小时，会出现锁释放前就开始检测死锁的问题。

lockwait_timeout 参数说明：控制单个锁的最长等待时间。当申请的锁等待时间超过设定值时，系统会报错。该参数仅针对常规锁生效。该参数可在PDB级别设置。 参数类型：整型 参数单位：ms（毫秒） 取值范围：0 ~ 2147483647 默认值：1200000（20min）。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。例如，不带单位取值900，表示lockwait_timeout为900ms；带单位取值20min，表示lockwait_timeout为20min。取值如果要带单位，必须为ms、s、min、h、d。 设置建议：一般设置为默认值。根据业务需要，业务需要锁冲突超过多久，该参数就设置多少。 设置不当的风险与影响：设置过大时，锁冲突造成的阻塞时间更长；设置过小时，可能会出现更多的锁超时报错。

Schema GaussDB的Schema如表1所示。 数据库禁止在提供功能接口的Schema下创建用户的业务数据，包括但不限于表、函数等（dbe_*, pkg_*）。 表1 GaussDB支持的Schema Schema名称 描述 db4ai 用于管理AI训练中不同版本的数据信息。 dbe_perf DBE_PERF Schema内视图主要用来诊断性能问题，也是WDR Snapshot的数据来源。数据库安装后，默认只有初始用户和监控管理员具有模式dbe_perf的权限，有权查看该模式下的视图和函数。 dbe_pldebugger 用于调试PL/SQL函数及存储过程。 snapshot 用于管理WDR snapshot的相关的数据信息，默认初始化用户或监控管理员用户可以访问。 sqladvisor 用于分布列推荐，集中式不可用。 sys 用于提供系统信息视图接口。 pg_catalog 用于维护系统的catalog信息，包含系统表和所有内置数据类型、函数、操作符。 pg_toast 用于存储大对象（系统内部使用）。 public 公共模式，用于存储公共对象。search_path参数缺省时，如果存在用户同名的模式则将创建的表（以及其他对象）默认创建到同名模式下，不存在用户同名模式则自动放入public模式。 pkg_service 用于管理package服务相关信息。 pkg_util 用于管理package工具相关信息。 dbe_raw 高级功能包dbe_raw，用于raw类型数据的转化、取子串、求长度等操作。 dbe_session 高级功能包dbe_session，用于设置指定属性的值（value），并支持用户查询校验。 dbe_lob 高级功能包dbe_lob，用于大文件（clob/blob）的读取、写入、复制等操作。 dbe_match 高级功能包dbe_match，用于字符串相似度的比较。 dbe_task 高级功能包dbe_task，用于作业任务的调度包括提交任务、取消任务、同步任务状态、更新任务信息等可以使数据库定期执行特定的任务。 dbe_sql 高级功能包dbe_sql，用于执行动态sql，可以在应用的运行时间构建查询和其他命令。 dbe_file 高级功能包dbe_file，用于数据库外部文件的读取、复制、写入、删除、重命名等。 dbe_output 高级功能包dbe_output，用于打印输出信息。 dbe_random 高级功能包dbe_random，用于生成随机种子和随机数。 dbe_application_info 高级功能包dbe_application_info，用于记录客户端信息。 dbe_utility 高级功能包dbe_utility，用于存储过程中调用调试工具，例如打印错误堆栈等。 dbe_scheduler 高级功能包dbe_scheduler，用于创建定时任务，通过程序(program)、调度(schedule)使数据库定期执行特定的任务。也可以通过授权、提供证书执行数据库外部任务。 information_schema 用于存储有关当前数据库中定义的对象的信息。 dbe_pldeveloper 用户存储过程编译调试。 dbe_xmlgen 高级功能包dbe_xmlgen，用于将查询结果转换成xml字符串。 dbe_stats 高级功能包dbe_stats，用于管理统计信息。 dbe_describe 高级功能包dbe_describe，用于查询存储过程或函数的参数信息。 dbe_sql_util SQL运维功能，目前包含SQL Patch和Plan Management的运维接口。 Information Schema DBE_PERF Schema WDR Snapshot Schema DBE_PLDEBUGGER Schema DB4AI Schema DBE_PLDEVELOPER DBE_SQL_UTIL Schema

告警场景 目前支持对以下7种导致性能问题的场景上报告警。 单列统计信息未收集 如果存在单列统计信息未收集，则上报相关告警。调优方法可以参考更新统计信息和统计信息调优。 告警信息示例： 整表的统计信息未收集： Statistic Not Collect: schema_test.t1 单列统计信息未收集： Statistic Not Collect: schema_test.t2(c1,c2) SQL不下推 对于不下推的SQL，尽可能详细上报导致不下推的原因。调优方法可以参考案例语句下推调优。 对于函数导致的不下推，告警导致不下推的函数名信息； 对于不支持下推的语法，会告警对应语法不支持下推，例如：含有With Recursive，Distinct On，row表达式，返回值为record类型的，会告警相应语法不支持下推等等。 告警信息示例： SQL is not plan-shipping, reason : "With Recursive" can not be shipped" SQL is not plan-shipping, reason : "Function now() can not be shipped" SQL is not plan-shipping, reason : "Function string_agg() can not be shipped" HashJoin中大表做内表 如果在表连接过程中使用了Hashjoin，且连接的内表行数是外表行数的10倍或以上；同时内表在每个DN上的平均行数大于10万行，且发生了下盘，则上报相关告警。调优方法可以参考使用plan hint调优执行计划。 告警信息示例： PlanNode[7] Large Table is INNER in HashJoin “Hash Aggregate” 大表等值连接使用Nestloop 如果在表连接过程中使用了nestloop，并且两个表中较大表的行数平均每个DN上的行数大于10万行、表的连接中存在等值连接，则上报相关告警。调优方法可以参考使用plan hint调优执行计划。 告警信息示例： PlanNode[5] Large Table with Equal-Condition use Nestloop"Nested Loop" 大表Broadcast 如果在Broadcast算子中，平均每DN的行数大于10万行，则告警大表broadcast。调优方法可以参考使用plan hint调优执行计划。 告警信息示例： PlanNode[5] Large Table in Broadcast "Streaming(type: BROADCAST dop: 1/2)" 数据倾斜 某表在各DN上的分布，存在某DN上的行数是另一DN上行数的10倍或以上，且有DN中的行数大于10万行，则上报相关告警。调优方法可以参考案例选择合适的分布列和数据倾斜调优。 告警信息示例： PlanNode[6] DataSkew:"Seq Scan", min_dn_tuples:0, max_dn_tuples:524288 估算不准 如果优化器的估算行数比实际行数大于10万行，并且估算行数和实际行数中较大值是较小值的10倍或以上，则上报相关告警。调优方法可以参考使用plan hint调优执行计划。 告警信息示例： PlanNode[5] Inaccurate Estimation-Rows: "Hash Join" A-Rows:0, E-Rows:52488

规格约束 告警字符串长度上限为2048。如果告警信息超过这个长度（例如存在大量未收集统计信息的超长表名，列名等信息）则不告警，只上报warning： WARNING, "Planner issue report is truncated, the rest of planner issues will be skipped" 如果query存在limit节点（即查询语句中包含limit），则不会上报limit节点以下的Operator级别的告警。 对于“数据倾斜”和“估算不准”两种类型告警，在某一个plan树结构下，只上报下层节点的告警，上层节点不再重复告警。这主要是因为这两种类型的告警可能是因为底层触发上层的。例如，如果在scan节点已经存在数据倾斜，那么在上层的hashagg等其他算子很可能也出现数据倾斜。

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

server_version 参数说明：报告服务器版本号(字符串形式)。 该参数属于INTERNAL类型参数，为固定参数，用户无法修改此参数，只能查看。该参数继承自PostgreSQL内核，表示当前数据库内核兼容PostgreSQL对应的server_version版本，无实际含义，为保持北向对外工具接口的生态兼容性(工具连接时查询)，保留该参数。该参数不建议使用，可通过函数opengauss_version()获取内核版本信息。 取值范围：字符串 默认值：9.2.4

server_version_num 参数说明：报告服务器版本号(整数形式)。 该参数属于INTERNAL类型参数，为固定参数，用户无法修改此参数，只能查看。该参数继承自PostgreSQL内核，表示当前数据库内核兼容PostgreSQL对应的server_version_num版本，无实际含义，为保持北向对外工具接口的生态兼容性(工具连接时查询)，保留该参数。 取值范围：整型 默认值：90204

enable_upgrade_merge_lock_mode 参数说明：当该参数设置为on时，通过提升deltamerge内部实现的锁级别，避免和update/delete并发操作时的报错。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 on，提升deltamerge内部实现的锁级别，并发执行deltamerge和update/delete操作时，一个操作先执行，另一个操作被阻塞，在前一个操作完成后，后一个操作再执行。 off，在对表的delta table的同一行并发执行deltamerge和update/delete操作时，后一个对同一行数据更新的操作会报错退出。 默认值：off

transparent_encrypt_kms_url 参数说明：它存储的是透明加密的数据库密钥获取地址，内容要求不可出现RFC3986标准外的字符，最大长度2047字节。格式为“kms://协议@KMS主机名1;KMS主机名2:KMS端口号/kms”，例如kms://https@linux175:29800/。该参数当前版本只适用于DWS场景。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：字符串 默认值：空

transparent_encrypted_string 参数说明：它存储的是透明加密的一个样本串，使用数据库加密密钥加密固定串“TRANS_ENCRYPT_SAMPLE_STRING”后的密文，用来校验二次启动时获取的DEK是否正确。如果校验失败，那么CN、DN将拒绝启动。该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。该参数当前版本只适用于DWS场景。 取值范围：字符串，设置为空表示整个集群为加密。 默认值：空 请勿手动设置该参数，设置不当将导致集群不可用。

use_elastic_search 参数说明：使能统一审计发送日志至Elastic Search系统, enable_security_policy打开且本参数打开后，统一审计日志会通过http(https)传递至Elastic Search系统（默认使用https安全协议）。此参数打开后需要保证elastic_search_ip_addr对应的es服务可正常连通，否则进程启动失败。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型。 on：使能统一审计日志发送至Elastic Search。 off：关闭统一审计日志发送至Elastic Search。 默认值：off

事务ID和快照 内部事务ID类型（xid）是64位。这些函数使用的数据类型txid_snapshot，存储在特定时刻事务ID可见性的信息。其组件描述在表12。 表12 快照组件 名称 描述 xmin 最早的事务ID（txid）仍然活动。所有较早事务将是已经提交可见的，或者是直接回滚。 xmax 作为尚未分配的txid。所有大于或等于此txids的都是尚未开始的快照时间，因此不可见。 xip_list 当前快照中活动的txids。这个列表只包含在xmin和xmax之间活动的txids；有可能活动的txids高于xmax。介于大于等于xmin、小于xmax，并且不在这个列表中的txid，在这个时间快照已经完成的，因此按照提交状态查看他是可见还是回滚。这个列表不包含子事务的txids。 txid_snapshot的文本表示为：xmin:xmax:xip_list。 示例：10:20:10,14,15意思为：xmin=10, xmax=20, xip_list=10, 14, 15。 以下的函数在一个输出形式中提供服务器事务信息。这些函数的主要用途是为了确定在两个快照之间有哪个事务提交。 pgxc_is_committed(transaction_id) 描述：如果提交或忽略给定的XID（gxid）。NULL表示的状态是未知的（运行、准备、冻结等）。 返回类型：bool txid_current() 描述：获取当前事务ID。 返回类型：bigint gs_txid_oldestxmin() 描述：获取当前最小事务id的值oldesxmin。 返回类型：bigint txid_current_snapshot() 描述：获取当前快照。 返回类型：txid_snapshot txid_snapshot_xip(txid_snapshot) 描述：在快照中获取正在进行的事务ID。 返回类型：setof bigint txid_snapshot_xmax(txid_snapshot) 描述：获取快照的xmax。 返回类型：bigint txid_snapshot_xmin(txid_snapshot) 描述：获取快照的xmin。 返回类型：bigint txid_visible_in_snapshot(bigint, txid_snapshot) 描述：在快照中事务ID是否可见（不使用子事务ID）。 返回类型：Boolean get_local_prepared_xact() 描述：获取当前节点两阶段残留事务信息，包括事务id，两阶段gid名称，prepared的时间，owner的oid，database的oid及当前节点的node_name。 返回类型：xid, text, timestamptz, oid, oid，text get_remote_prepared_xacts() 描述：获取所有远程节点两阶段残留事务信息，包括事务id，两阶段gid名称，prepared的时间，owner的名称，database的名称及node_name。 返回类型：xid, text, timestamptz, name, name，text global_clean_prepared_xacts(text, text) 描述：并发清理两阶段残留事务，仅gs_clean工具调用该函数进行清理，其他情况下调用均返回false。 返回类型：Boolean pgxc_stat_get_wal_senders() 描述：返回集群中所有主DN的发送日志的信息和其对应的备DN的接收日志的信息。仅支持system admin或monitor admin权限用户使用。 返回值如下： 表13 pgxc_stat_get_wal_senders返回参数说明 字段名 描述 nodename 实例名。 sender_pid 发送日志的线程pid。 local_role 实例角色。 peer_role 接收端的实例的角色。 peer_state 接收端的实例的状态。 state 实例间同步的状态。 sender_sent_location 发送端发送日志的位置。 sender_write_location 发送端写日志的位置。 sender_flush_location 发送端刷盘日志的位置。 sender_replay_location 当前实例的日志位置。如果是主DN，则该位置和 sender_flush_location相同；否则该位置为当前实例日志回放到的位置。 receiver_received_location 接收端日志接收到的位置。 receiver_write_location 接收端日志写的位置。 receiver_flush_location 接收端日志刷盘的位置。 receiver_replay_location 接收端日志回放的位置。 pgxc_stat_get_wal_senders_status() 描述：返回所有节点事务日志接收状态。仅支持system admin或monitor admin权限用户使用。 返回值如下： 表14 pgxc_stat_get_wal_senders_status返回参数说明 字段名 描述 nodename 主节点名。 source_ip 主节点IP。 source_port 主节点端口。 dest_ip 备节点IP。 dest_port 备节点端口。 sender_pid 发送线程PID。 local_role 主节点类型。 peer_role 备节点类型。 peer_state 备节点状态。 state wal sender状态。 sender_sent_location 主节点发送位置。 sender_write_location 主节点落盘位置。 sender_replay_location 主节点redo位置。 receiver_received_location 备节点接收位置。 receiver_write_location 备节点落盘位置。 receiver_flush_location 备节点flush磁盘位置。 receiver_replay_location 备节点redo位置。 gs_get_next_xid_csn() 描述：返回全局所有节点上的next_xid和next_csn值。 返回值如下： 表15 gs_get_next_xid_csn返回参数说明 字段名 描述 nodename 节点名称。 next_xid 当前节点下一个事务id号。 next_csn 当前节点下一个csn号。 simsearch_lib_load_status() 描述: 搜索动态库的状态加载成功或者失败。 返回值类型：SETOF record simsearch_gpu_vector_status() 描述：搜索searchlet的状态是否有向量。 返回值类型：SETOF record 由于规格变更，当前版本已经不再支持该函数，请不要使用。 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_delta_info 描述：从单个dn获取delta info。 参数：rel text, schema_name text 返回值类型：part_name text, live_tuple bigint, data_size bigint, blocknum bigint pgxc_get_delta_info 描述：从全部dn获取delta info。仅sysadmin和monitor admin用户可以访问。 参数：rel text, schema_name text 返回值类型：part_name text, live_tuple bigint, data_size bigint, blocknum bigint pg_get_replication_slot_name 描述：获取slot name。 参数：nan 返回值类型：text pg_get_running_xacts 描述：获取运行中的xact。 参数：nan 返回值类型：handle integer, gxid xid, state tinyint, node text, xmin xid, vacuum boolean, timeline bigint, prepare_xid xid, pid bigint, next_xid xid 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_stat_file_recursive 描述：列出路径下所有文件。 参数：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_stat_get_session_wlmstat 描述：返回当前会话负载信息。 参数：pid integer 返回值类型：datid oid, threadid bigint, sessionid bigint, threadpid integer, usesysid oid, appname text, query text, priority bigint, block_time bigint, elapsed_time bigint, total_cpu_time bigint, skew_percent integer, statement_mem integer, active_points integer, dop_value integer, current_cgroup text, current_status text, enqueue_state text, attribute text, is_plana boolean, node_group text, srespool name pg_stat_get_wlm_instance_info 描述：返回当前实例负载信息。 参数：nan 返回值类型：instancename text, timestamp timestamp with time zone, used_cpu integer, free_memory integer, used_memory integer, io_await double precision, io_util double precision, disk_read double precision, disk_write double precision, process_read bigint, process_write bigint, logical_read bigint, logical_write bigint, read_counts bigint, write_counts bigint pg_stat_get_wlm_instance_info_with_cleanup 描述：返回当前实例负载信息，并且保存到系统表中。 参数：nan 返回值类型：instancename text, timestamp timestamp with time zone, used_cpu integer, free_memory integer, used_memory integer, io_await double precision, io_util double precision, disk_read double precision, disk_write double precision, process_read bigint, process_write bigint, logical_read bigint, logical_write bigint, read_counts bigint, write_counts bigint pg_stat_get_wlm_node_resource_info 描述：获取当前节点资源信息。 参数：nan 返回值类型：min_mem_util integer, max_mem_util integer, min_cpu_util integer, max_cpu_util integer, min_io_util integer, max_io_util integer, used_mem_rate integer pg_stat_get_wlm_operator_info 描述：从内部哈希表中获取执行计划算子信息。 参数：nan 返回值类型：queryid bigint, pid bigint, plan_node_id integer, plan_node_name text, start_time timestamp with time zone, duration bigint, query_dop integer, estimated_rows bigint, tuple_processed bigint, min_peak_memory integer, max_peak_memory integer, average_peak_memory integer, memory_skew_percent integer, min_spill_size integer, max_spill_size integer, average_spill_size integer, spill_skew_percent integer, min_cpu_time bigint, max_cpu_time bigint, total_cpu_time bigint, cpu_skew_percent integer, warning text pg_stat_get_wlm_realtime_operator_info 描述：从内部哈希表中获取实时执行计划算子信息。 参数：nan 返回值类型：queryid bigint, pid bigint, plan_node_id integer, plan_node_name text, start_time timestamp with time zone, duration bigint, status text, query_dop integer, estimated_rows bigint, tuple_processed bigint, min_peak_memory integer, max_peak_memory integer, average_peak_memory integer, memory_skew_percent integer, min_spill_size integer, max_spill_size integer, average_spill_size integer, spill_skew_percent integer, min_cpu_time bigint, max_cpu_time bigint, total_cpu_time bigint, cpu_skew_percent integer, warning text pg_stat_get_wlm_realtime_session_info 描述：返回实时会话负载信息。 参数：nan 返回值类型：nodename text, threadid bigint, block_time bigint, duration bigint, estimate_total_time bigint, estimate_left_time bigint, schemaname text, query_band text, spill_info text, control_group text, estimate_memory integer, min_peak_memory integer, max_peak_memory integer, average_peak_memory integer, memory_skew_percent integer, min_spill_size integer, max_spill_size integer, average_spill_size integer, spill_skew_percent integer, min_dn_time bigint, max_dn_time bigint, average_dn_time bigint, dntime_skew_percent integer, min_cpu_time bigint, max_cpu_time bigint, total_cpu_time bigint, cpu_skew_percent integer, min_peak_iops integer, max_peak_iops integer, average_peak_iops integer, iops_skew_percent integer, warning text, query text, query_plan text, cpu_top1_node_name text, cpu_top2_node_name text, cpu_top3_node_name text, cpu_top4_node_name text, cpu_top5_node_name text, mem_top1_node_name text, mem_top2_node_name text, mem_top3_node_name text, mem_top4_node_name text, mem_top5_node_name text, cpu_top1_value bigint, cpu_top2_value bigint, cpu_top3_value bigint, cpu_top4_value bigint, cpu_top5_value bigint, mem_top1_value bigint, mem_top2_value bigint, mem_top3_value bigint, mem_top4_value bigint, mem_top5_value bigint, top_mem_dn text, top_cpu_dn text pg_stat_get_wlm_session_info_internal 描述：返回会话负载信息。 参数：oid, bigint, bigint, oid 返回值类型：SETOF text pg_stat_get_wlm_session_iostat_info 描述：返回会话负载I/O信息。 参数：nan 返回值类型：threadid bigint, maxcurr_iops integer, mincurr_iops integer, maxpeak_iops integer, minpeak_iops integer, iops_limits integer, io_priority integer, curr_io_limits integer pg_stat_get_wlm_statistics 描述：返回会话负载统计数据。 参数：nan 返回值类型：statement text, block_time bigint, elapsed_time bigint, total_cpu_time bigint, qualification_time bigint, skew_percent integer, control_group text, status text, action text pg_test_err_contain_err 描述：测试错误类型和返回信息。 参数：integer 返回值类型：void pv_session_memory_detail_tp 描述：返回会话的内存使用情况，参考pv_session_memory_detail。 参数：nan 返回值类型：sessid text, sesstype text, contextname text, level smallint, parent text, totalsize bigint, freesize bigint, usedsize bigint gs_get_table_distribution 描述：返回表数据在各个数据节点的分布情况。 参数：table_name text, schema_name text 返回值类型：text pv_builtin_functions 描述：查看所有内置系统函数信息。 参数：nan 返回值类型：proname name, pronamespace oid, proowner oid, prolang oid, procost real, prorows real, provariadic oid, protransform regproc, proisagg boolean, proiswindow boolean, prosecdef boolean, proleakproof boolean, proisstrict boolean, proretset boolean, provolatile "char", pronargs smallint, pronargdefaults smallint, prorettype oid, proargtypes oidvector, proallargtypes integer[], proargmodes "char"[], proargnames text[], proargdefaults pg_node_tree, prosrc text, probin text, proconfig text[], proacl aclitem[], prodefaultargpos int2vector, fencedmode boolean, proshippable boolean, propackage boolean, oid oid pv_thread_memory_detail 描述：返回各线程的内存信息。 参数：nan 返回值类型：threadid text, tid bigint, thrdtype text, contextname text, level smallint, parent text, totalsize bigint, freesize bigint, usedsize bigint pg_shared_memory_detail 描述：返回所有已产生的共享内存上下文的使用信息，各列描述请参考SHARED_MEMORY_DETAIL。 参数：nan 返回值类型：contextname text, level smallint, parent text, totalsize bigint, freesize bigint, usedsize bigint pgxc_get_running_xacts 描述：返回集群中各个节点运行事务的信息，字段内容和PGXC_RUNNING_XA CTS 相同。只有system admin和monitor admin用户有权限查看。 参数：nan 返回值类型：setof record pgxc_snapshot_status() 描述：在GTM模式下，返回GTM中关键内存信息状态，用来支持问题定位，GTM-Free、GTM-Lite不支持本函数。 参数：nan 返回值类型：xmin xid, xmax xid, xcnt int, oldestxmin xid, next_xid xid, timeline int, active_thread_num int, max_active_thread_num int, snapshot_num int, snapshot_totalsize bigint 返回值描述如下： 表16 get_gtm_lite_status返回参数说明 字段名 描述 xmin GTM上当前最小的活跃事务id。 xmax GTM上当前提交的最大的事务id + 1，大于等于该值的事务id是活跃的。 xcnt GTM上当前活跃事务个数。 oldestxmin GTM上最老被访问的事务id号。 next_xid GTM上下一个分配的事务id号。 timeline GTM上当前的时间线。 active_thread_num GTM上当前活跃的工作线程数。 max_active_thread_num GTM上1分钟内工作线程数峰值。 snapshot_num GTM上1分钟内下发的快照个数。 snapshot_totalsize GTM上1分钟内下发快照总大小。 get_gtm_lite_status() 描述：返回GTM上的backupXid和csn号，用来支持问题定位，GTM-FREE模式下不支持使用本系统函数。 返回值如下： 表17 get_gtm_lite_status返回参数说明 字段名 描述 backup_xid GTM上的备份Xid值。 csn GTM当前下发的最新的csn号。

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

系统表信息函数 format_type(type_oid, typemod) 描述：获取数据类型的SQL名称 返回类型：text 备注：format_type通过某个数据类型的OID以及可能的修饰词，返回其SQL名称。如果不知道具体的修饰词，则在修饰词的位置传入NULL。修饰词一般只对有长度限制的数据类型有意义。format_type所返回的SQL名称中包含数据类型的长度值，其大小是：实际存储长度len - sizeof(int32)，单位字节。原因是数据存储时需要32位的空间来存储用户对数据类型的自定义长度信息，即实际存储长度要比用户定义长度多4个字节。在下例中，format_type返回的SQL名称为“character varying(6)”，6表示varchar类型的长度值是6字节，因此该类型的实际存储长度为10字节。 1 2 3 4 5 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) + 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) + 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 9 10 11 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返回传递给他的值的排序。示例： 1 2 3 4 5 openGauss=# SELECT collation for (description) FROM pg_description LIMIT 1; pg_collation_for ------------------ "default" (1 row) 值可能是引号括起来的并且模式限制的。如果没有为参数表达式排序，则返回一个null值。如果参数不是排序的类型，则抛出一个错误。 getdistributekey(table_name) 描述：获取一个hash表的分布列。 返回类型：text 示例： 1 2 3 4 5 openGauss=# SELECT getdistributekey('item'); getdistributekey ------------------ i_item_sk (1 row)

模式可见性查询函数 每个函数执行检查数据库对象类型的可见性。对于函数和操作符，如果在前面的搜索路径中没有相同的对象名称和参数的数据类型，则此对象是可见的。对于操作符类，则要同时考虑名称和相关索引的访问方法。 所有这些函数都需要使用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

访问权限查询函数 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语句。 REFEREN CES ：允许创建一个外键约束（分布式场景暂不支持）。 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_database_privilege(user, database, privilege) 描述：指定用户是否有访问数据库的权限。 表4 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或id。 database text，oid 数据库 数据库名字或id。 privilege text 权限 CREATE：对于数据库，允许在数据库里创建新的模式。 TEMPORARY：允许在使用数据库的时候创建临时表。 TEMP：允许在使用数据库的时候创建临时表。 CONNECT：允许用户连接到指定的数据库。 ALTER：允许用户修改指定对象的属性。 DROP：允许用户删除指定的对象。 COMMENT：允许用户定义或修改指定对象的注释。 返回类型：Boolean has_database_privilege(database, privilege) 描述：当前用户是否有访问数据库的权限，合法参数类型见表4。 返回类型：Boolean 备注：has_database_privilege检查用户是否能以在特定方式访问数据库。其参数类似has_table_privilege。访问权限类型必须是CREATE、CONNECT、TEMPORARY或TEMP（等价于TEMPORARY）的一些组合。 has_directory_privilege(user, directory, privilege) 表5 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或id。 directory text，oid 目录 目录名字或者oid。 privilege text 权限 READ：允许对该目录进行读操作。 WRITE:允许对该目录进行写操作。 描述：指定用户是否有访问directory的权限。 返回类型：Boolean has_directory_privilege(directory, privilege) 描述：当前用户是否有访问directory的权限，合法参数类型见表5。 返回类型：Boolean has_foreign_data_wrapper_privilege(user, fdw, privilege) 表6 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或者id。 fdw text，oid 外部数据封装器 外部数据封装器名字或id。 privilege text 权限 USAGE：允许访问外部数据封装器。 描述：指定用户是否有访问外部数据封装器的权限。 返回类型：Boolean has_foreign_data_wrapper_privilege(fdw, privilege) 描述：当前用户是否有访问外部数据封装器的权限，合法参数类型见表6。 返回类型：Boolean 备注：has_foreign_data_wrapper_privilege检查用户是否能以特定方式访问外部数据封装器。其参数类似has_table_privilege。访问权限类型必须是USAGE。 has_function_privilege(user, function, privilege) 表7 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或者id function text，oid 函数 函数名称或id privilege text 权限 EXECUTE：允许使用指定的函数，以及利用这些函数实现的操作符。 ALTER：允许用户修改指定对象的属性。 DROP：允许用户删除指定的对象。 COMMENT：允许用户定义或修改指定对象的注释。 描述：指定用户是否有访问函数的权限。 返回类型：Boolean has_function_privilege(function, privilege) 描述：当前用户是否有访问函数的权限。合法参数类型见表7。 返回类型：Boolean 备注：has_function_privilege检查一个用户是否能以指定方式访问一个函数。其参数类似has_table_privilege。使用文本字符而不是OID声明一个函数时，允许输入的类型和regprocedure数据类型一样（请参考对象标识符类型）。访问权限类型必须是EXECUTE。 has_language_privilege(user, language, privilege) 表8 参数类型说明 参数名 合法入参类型 描述 取值范围 user name，oid 用户 用户名字或id。 language text，oid 语言 语言名称或id。 privilege text 权限 USAG：对于过程语言，允许用户在创建函数的时候指定过程语言。 描述：指定用户是否有访问语言的权限。 返回类型：Boolean has_language_privilege(language, privilege) 描述：当前用户是否有访问语言的权限。合法参数类型见表8。 返回类型：Boolean 备注：has_language_privilege检查用户是否能以特定方式访问一个过程语言。其参数类似has_table_privilege。访问权限类型必须是USAGE。 has_nodegroup_privilege(user, nodegroup, privilege) 描述：检查用户是否有集群节点访问权限。 返回类型：Boolean 表9 参数类型说明 参数名 合法入参类型 描述 取值范围 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 表10 参数类型说明 参数名 合法入参类型 描述 取值范围 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 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 openGauss=# CREATE TABLE tt(a int); NOTICE: The 'DISTRIBUTE BY' clause is not specified. Using 'a' as the distribution column by default. HINT: Please use 'DISTRIBUTE BY' clause to specify suitable data distribution column. CREATE TABLE openGauss=# SELECT has_table_privilege('tt', 'select'); has_table_privilege --------------------- t (1 row) # 查看数据库用户名列表 openGauss=# \du; List of roles Role name | Attributes | Member of -------------+------------------------------------------------------------------------------------------------------------------+----------- omm | Sysadmin, Create role, Create DB, Replication, Administer audit, Monitoradmin, Operatoradmin, Policyadmin, UseFT | {} simple_user | | {} test | Sysadmin | {} openGauss=# SELECT has_table_privilege('omm', 'tt', '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 表11 参数类型说明 参数名 合法入参类型 描述 取值范围 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]