华为云用户手册

autoanalyze 参数说明：标识是否允许在生成计划的时候，对于没有统计信息的表进行统计信息自动收集。对于临时表，不支持autoanalyze，如果需要收集统计信息，用户需手动执行analyze操作。如果在auto analyze某个表的过程中数据库发生异常，当数据库正常运行之后再执行语句有可能仍提示需要收集此表的统计信息。此时需要用户对该表手动执行一次analyze操作，以同步统计信息数据。 该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 on表示允许自动进行统计信息收集。 off表示不允许自动进行统计信息收集。 默认值：off 该参数与autovacuum线程下的autoanalyze无关。

plan_mode_seed 参数说明：该参数为调测参数，目前仅支持OPTIMIZE_PLAN和RANDOM_PLAN两种。其中：OPTIMIZE_PLAN表示通过动态规划算法进行代价估算的最优plan，参数值设置为0；RANDOM_PLAN表示随机生成的plan；如果设置为-1，表示用户不指定随机数的种子标识符seed值，由优化器随机生成[1, 2147483647]范围整型值的随机数，并根据随机数生成随机的执行计划；如果用户指定guc参数值为[1, 2147483647]范围的整型值，表示指定的生成随机数的种子标识符seed，优化器需要根据seed值生成随机的执行计划。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，-1~ 2147483647 默认值：0 当该参数设置为随机执行计划模式时，优化器会生成不同的随机执行计划，该执行计划可能不是最优计划。因此在随机计划模式下，会对查询性能产生影响，所以建议在升级、扩容、缩容等正常业务操作或运维过程中将该参数保持为默认值0。 当该参数不为0时，查询指定的plan hint不会生效。

session_sequence_cache 参数说明：在当前会话下，一次性交互申请的sequence数值，会话结束会自动丢弃未用完的值。用户在使用sequence大批量导入数据的时候可以通过调大该参数，提高插入速度，增加高并发性能；用户在高并发单条插入数据的时候，将该参数设置为1，减少了sequence的跳变。如对连续性有强要求，需要在创建sequence的时候指定需要的cache，该参数如果大于cache指定的值会自动失效。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，1 ~ 2147483647。 默认值：10 默认值为10是高并发场景下，兼顾单条插入和批量插入的性能会有比较好的表现。

router 参数说明：用于控制router功能的详细属性，仅在打开enable_router和enable_light_proxy后生效。该参数会根据表的hash分布列，计算给定的分布列在哪个DN上，设置router后将支持的sql下推到该DN上执行。如果设置错了router，可能导致数据存入错误的dn，导致不可预测的问题，需谨慎使用。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：字符串 该参数分为两部分，'schema_name.table_name,"distribute_keys"'，其具体含义如下： schema_name.table_name：表示schema名和表名，如不显示设置schema_name，则默认为current_schema。 distribute_keys：分布表的所有分布列值，用逗号间隔开，且分布列值的顺序必须和表中分布列顺序一致。 默认值：空

cost_param 参数说明：该参数用于控制在特定的客户场景中，使用不同的估算方法使得估算值与真实值更接近。此参数可以同时控制多种方法，与某一方法对应的位做与操作，不为0表示该方法被选择。 当cost_param & 1不为0，表示对于求不等值连接选择率时选择一种改良机制，此方法在自连接（两个相同的表之间连接）的估算中更加准确。当前版本已弃用cost_param & 1不为0时的路径，默认选择更优的估算公式。 当cost_param & 2不为0，表示求多个过滤条件（Filter）的选择率时，选择最小的作为总的选择率，而非两者乘积，此方法在过滤条件的列之间关联性较强时估算更加准确。 当cost_param & 4不为0，表示在进行stream节点估算时，选用调试模型，该模型不推荐用户使用。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，0～2147483647‬ 默认值：0

explain_perf_mode 参数说明：此参数用来指定explain的显示格式。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：normal、pretty、summary、run normal：代表使用默认的打印格式。 pretty：代表使用 GaussDB 改进后的新显示格式。新的格式层次清晰，计划包含了plan node id，性能分析简单直接。 summary：是在pretty的基础上增加了对打印信息的分析。 run：在summary的基础上，将统计的信息输出到csv格式的文件中，以便于进一步分析。 默认值：pretty pretty模式当前只支持包含stream算子的计划，不支持下发语句到DN节点的计划。因此显示格式会受enable_stream_operator参数影响，当enable_stream_operator设置为off时无法生成包含stream算子的计划。

enable_fast_numeric 参数说明：标识是否开启Numeric类型数据运算优化。Numeric数据运算是较为耗时的操作之一，通过将Numeric转化为int64/int128类型，提高Numeric运算的性能。 该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 on/true表示开启Numeric优化。 off/false表示关闭Numeric优化。 默认值：on

constraint_exclusion 参数说明：控制查询优化器使用表约束查询的优化。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：枚举类型 on/true/yes/1表示检查所有表的约束。 off/false/no/0表示不检查约束。 partition表示只检查继承的子表和UNION ALL子查询。 当constraint_exclusion为on，优化器用查询条件和表的CHECK约束比较，并且在查询条件和约束冲突的时候忽略对表的扫描。 默认值：partition 目前， constraint_exclusion缺省被打开，通常用来实现表分区。为所有的表打开它时，对于简单的查询强加了额外的规划，并且对简单查询没有什么好处。如果不用分区表，可以关掉它。

enable_global_plancache 参数说明：设置是否对PBE查询的执行计划进行缓存共享，开启该功能可以节省高并发下CN和DN上的内存使用。且该参数必须在CN和DN上一致，否则会出现CN下发给DN的报文不匹配从而报错等问题。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 在打开enable_global_plancache的情况下，为保证GPC生效，默认local_syscache_threshold不小于16MB。即如当前local_syscache_threshold小于16MB，则设置为16MB，如大于16MB，则不改变。 取值范围：布尔型。 on表示对PBE查询的执行计划进行缓存共享。 off表示不共享。 默认值：off

analysis_options 参数说明：通过开启对应选项中所对应的功能选项使用相应的定位功能，包括数据校验，性能统计等，参见取值范围中的选项说明。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：字符串 HASH_CONFLICT表示在DN进程的pg_log目录中的log日志中显示hash表的统计信息，包括hash表大小，hash链长，hash冲突情况。 STREAM_DATA_CHECK表示对网络传输前后的数据进行CRC校验。 默认值：ALL,on(),off(HASH_CONFLICT,STREAM_DATA_CHECK)，不开启任何定位功能。

enable_gpc_grayrelease_mode 参数说明：分布式集群下，开启GPC需要重启集群。如果需要在不重启集群的情况下开启GPC，需要用enable_gpc_grayrelease_mode控制滚动开启GPC或关闭GPC。 分布式集群上操作方式。 开启GPC： 1、在所有DN节点开启enable_gpc_grayrelease_mode。 2、在所有CN节点开启enable_gpc_grayrelease_mode。 3、开启GPC参数，由于GPC是POSTMASTER参数，需要先reload参数，之后轮询kill节点，使重新拉起的节点上GPC生效。 关闭GPC： 1、首先确定enable_gpc_grayrelease_mode 是on的状态，reload关闭GPC参数，然后轮询kill节点，使重新拉起的节点上GPC生效。 2、在所有CN节点关闭enable_gpc_grayrelease_mode。 3、在所有DN节点关闭enable_gpc_grayrelease_mode。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型。 on off 默认值：off

enable_global_stats 参数说明：标识当前统计信息模式，区别采用全局统计信息收集模式还是单节点统计信息收集模式，默认创建为采用全局统计信息模式。当关闭该参数时，则默认收集集群第一个节点的统计信息，此时可能会影响生成查询计划的质量，但信息收集性能较优，建议谨慎设置。 该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 on/true表示全局统计信息。 off/false表示单DN统计信息。 默认值：on

enable_opfusion 参数说明：控制是否对简单查询进行查询优化。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 该开关是优化DN的查询性能，可以设置max_datanode_for_plan查看一个查询DN的执行计划，如果DN的执行计划中带有[Bypass]标识则代表该查询在该DN可以查询优化。 简单查询限制如下： 只支持indexscan和indexonlyscan，且全部WHERE语句的过滤条件都在索引上。 只支持单表增删改查，不支持join、using。 只支持行存表，不支持分区表，表不支持有触发器。 不支持active sql、QPS等信息统计特性。 不支持正在扩容和缩容的表。 不支持查询或者修改系统列。 只支持简单SELECT语句，例如： SELECT c3 FROM t1 WHERE c1 = ? and c2 =10; 仅可以查询目标表的列，c1和c2列为索引列，后边可以是常量或者参数，可以使用 for update。 只支持简单INSERT语句，例如： INSERT INTO t1 VALUES (?,10,?); 仅支持一个VALUES，VALUES里面的类型可以是常量和参数，不支持returning。 只支持简单DELETE语句，例如： DELETE FROM t1 WHERE c1 = ? and c2 = 10; c1和c2列为索引列，后边可以是常量或者参数。 只支持简单UPDATE语句，例如： UPDATE t1 SET c3 = c3+? WHERE c1 = ? and c2 = 10; c3列修改的值可以是常量和参数，也可以是一个简单的表达式，c1和c2列为索引列，后边可以是常量或者参数。 取值范围：布尔型 on表示使用。 off表示不使用。 默认值：on

PG_PLTEMPLATE PG_PLTEMPLATE系统表存储过程语言的“模板”信息。 表1 PG_PLTEMPLATE字段 名称 类型 描述 tmplname name 这个模板所应用的语言的名称。 tmpltrusted boolean 如果语言被认为是可信的，则为真。否则为假。 tmpldbacreate boolean 如果语言是由数据库所有者创建的，则为真。否则为假。 tmplhandler text 调用处理器函数的名称。 tmplinline text 匿名块处理器的名称，若没有则为NULL。 tmplvalidator text 校验函数的名称，如果没有则为NULL。 tmpllibrary text 实现语言的共享库的路径。 tmplacl aclitem[] 模板的访问权限（未使用）。 父主题： 系统表

接口介绍 高级功能包DBE_FILE支持的所有接口请参见表1。 表1 DBE_FILE 接口名称 描述 DBE_FILE.OPEN 根据指定的目录和文件名打开一个文件。 DBE_FILE.IS_CLOSE 检测一个文件句柄是否关闭。 DBE_FILE.IS_OPEN 检测一个文件句柄是否打开。 DBE_FILE.READ_LINE 从一个打开的文件句柄中读取一行指定长度的数据。 DBE_FILE.WRITE 将数据写入到一个打开的文件的缓冲区中。 DBE_FILE.NEW_LINE 将一个或者多个行终结符写入到一个打开的文件的缓冲区中。 DBE_FILE.WRITE_LINE 将数据写入到一个打开的文件的缓冲区中，并自动追加一个行终结符。 DBE_FILE.FORMAT_WRITE 将数据按指定格式写入到一个打开的文件的缓冲区中。 DBE_FILE.GET_RAW 从一个打开的文件中读取指定字节数的RAW类型数据。 DBE_FILE.PUT_RAW 将RAW类型数据写入到一个打开的文件的缓冲区中。 DBE_FILE.FLUSH 将缓存区中的数据写入到物理文件中。 DBE_FILE.CLOSE 关闭一个打开的文件句柄。 DBE_FILE.CLOSE_ALL 关闭一个会话中打开的所有的文件句柄。 DBE_FILE.REMOVE 根据指定的目录和文件名删除一个磁盘文件，操作的时候需要有充分的权限。 DBE_FILE.RENAME 重命名一个磁盘文件，类似Unix的mv指令。 DBE_FILE.COPY 复制一个连续区域的内容到一个新创建的文件中，如果忽略了start_line和end_line会复制整个文件。 DBE_FILE.GET_ATTR 读取并返回一个磁盘文件的属性。 DBE_FILE.SEEK 根据用户指定的字节数向前或者向后调整文件指针的位置。 DBE_FILE.GET_POS 以字节为单位返回文件当前的偏移量。 DBE_FILE.OPEN 该函数用来打开一个文件，可以指定最大行的大小，最多可以同时打开50个文件。并且该函数返回INTEGER类型的一个句柄。 DBE_FILE.OPEN函数原型为： 1 2 3 4 5 6 DBE_FILE.OPEN ( dir IN VARCHAR2, file_name IN VARCHAR2, open_mode IN VARCHAR2, max_line_size IN INTEGER DEFAULT 1024) RETURN INTEGER; 表2 DBE_FILE.OPEN接口参数说明 参数 类型 入参/出参 是否可以为空 描述 dir VARCHAR2 IN 否 文件的目录位置，这个字符串是一个目录对象名。 说明： 文件目录的位置，需要添加到系统表PG_DIRECTORY中，如果传入的路径和PG_DIRECTORY中的路径不匹配，会报路径不存在的错误，下面的涉及location作为参数的函数也是同样的情况。 在打开guc参数safe_data_path时，用户只能通过高级包读写safe_data_path指定文件路径下的文件。 file_name VARCHAR2 IN 否 文件名，包含扩展（文件类型），不包括路径名。如果文件名中包含路径，在OPEN中会被忽略，在UNIX系统中，文件名不能以/.结尾。 open_mode VARCHAR2 IN 否 指定文件的打开模式，包含r：read text，w: write text和a: append text。 说明： 对于写操作，会检测写入文件类型，如果为elf类型文件，会报错退出。 max_line_size INTEGER IN 是 每行最大字符数，包含换行符（最小值是1，最大值是32767）。如果没有指定，会指定一个默认值1024。 DBE_FILE.IS_OPEN 函数DBE_FILE.IS_OPEN用于检测一个文件是否已经打开，返回一个布尔值，异常情况是INVALID_FILEHANDLE。 DBE_FILE.IS_OPEN函数原型为： 1 2 3 DBE_FILE.IS_OPEN( file IN INTEGER) RETURN BOOLEAN; 表3 DBE_FILE.IS_OPEN接口参数说明 参数 类型 入参/出参 是否可以为空 描述 file INTEGER IN 是 待检测的文件句柄，为空时DBE_FILE.IS_OPEN接口返回FALSE。 DBE_FILE.IS_CLOSE 函数DBE_FILE.IS_CLOSE用于检测一个文件句柄是否已经关闭，返回布尔值，异常情况是INVALID_FILEHANDLE。 DBE_FILE.IS_CLOSE函数原型为： 1 2 3 DBE_FILE.IS_CLOSE ( file IN INTEGER) RETURN BOOLEAN; 表4 DBE_FILE.IS_CLOSE接口参数说明 参数 类型 入参/出参 是否可以为空 描述 file INTEGER IN 是 传入一个要检测的文件句柄。 DBE_FILE.READ_LINE 存储过程DBE_FILE.READ_LINE从一个打开的文件读取数据，并把读取的结果存放到BUFFER中。读取的时候会读取到行尾，但不包含行终结符，或者读取到文件末尾，或者读取到len参数指定的大小。读取的长度不能超过OPEN的时候指定的max_line_size。 DBE_FILE.READ_LINE函数原型为： 1 2 3 4 DBE_FILE.READ_LINE ( file IN INTEGER, buffer OUT VARCHAR2, len IN INTEGER DEFAULT NULL) 表5 DBE_FILE.READ_LINE接口参数说明 参数 类型 入参/出参 是否可以为空 描述 file INTEGER IN 否 通过调用OPEN打开的文件句柄，文件必须以读的模式打开，否则会抛出INVALID_OPERATION的异常。 buffer VARCHAR2 OUT 否 用于接收数据的BUFFER。 len INTEGE IN 是 从文件中读取的字节数，默认是NULL。如果是默认NULL，会使用max_line_size来指定大小。 DBE_FILE.WRITE 函数DBE_FILE.WRITE用于向文件对应的缓冲区中写入BUFFER中的数据，文件必须以写模式打开，这个操作不会写入行终结符。 DBE_FILE.WRITE函数原型为： 1 2 3 4 DBE_FILE.WRITE ( file IN INTEGER, buffer IN TEXT) RETURN BOOLEAN; 表6 DBE_FILE.WRITE接口参数说明 参数 类型 入参/出参 是否可以为空 描述 file INTEGER IN 否 通过OPEN打开的文件句柄，要写入的文件必须以写模式打开，这个操作不会写入行终结符。 buffer TEXT IN 是 要写入文件的文本数据，BUFFER的最大值是32767个字节。如果在open的时候没有指定值，默认是1024个字节，没有刷新到文件之前，一系列的WRITE操作的BUFFER总和不能超过32767个字节。 说明： 对于写操作，会检测写入文件类型，如果为elf类型文件，会报错退出。 DBE_FILE.NEW_LINE 函数DBE_FILE.NEW_LINE用于向文件对应的缓冲区中写入一个或者多个行终结符，行终结符和平台相关。 DBE_FILE.NEW_LINE函数原型为： 1 2 3 4 DBE_FILE.NEW_LINE ( file IN INTEGER, line_nums IN INTEGER := 1) RETURN BOOLEAN; 表7 DBE_FILE.NEW_LINE接口参数说明 参数 类型 入参/出参 是否可以为空 描述 file INTEGER IN 否 通过OPEN打开的文件句柄。 line_nums INTEGER IN 是 写入到文件中的终结符的数量，默认值为1。 DBE_FILE.WRITE_LINE 函数DBE_FILE.WRITE_LINE用于向文件对应的缓冲区中写入BUFFER中的数据，文件必须以写模式打开，这个操作会自动追加行终结符。 DBE_FILE.WRITE_LINE函数原型为： 1 2 3 4 5 DBE_FILE.WRITE_LINE( file IN INTEGER, buffer IN TEXT, flush IN BOOLEAN DEFAULT FALSE) RETURN BOOLEAN; 表8 DBE_FILE.WRITE_LINE接口参数说明 参数 类型 入参/出参 是否可以为空 描述 file INTEGER IN 否 通过OPEN打开的文件句柄。 buffer TEXT IN 是 要写入文件的文本数据，BUFFER的最大值是32767个字节。如果在open的时候没有指定值，默认是1024个字节，没有刷新到文件之前，一系列的PUT操作的BUFFER总和不能超过32767个字节。 说明： 对于写操作，会检测写入文件类型，如果为elf类型文件，会报错退出。 flush BOOLEAN IN 是 在write后是否要刷到磁盘。 DBE_FILE.FORMAT_WRITE 函数DBE_FILE.FORMAT_WRITE将格式化数据写入到一个打开的文件对应的缓冲区中，是允许格式化的DBE_FILE.WRITE接口。 DBE_FILE.FORMAT_WRITE函数原型为： 1 2 3 4 5 6 7 DBE_FILE.FORMAT_WRITE ( file IN INTEGER, format IN VARCHAR2, arg1 IN VARCHAR2 DEFAULT NULL, . . . arg6 IN VARCHAR2 DEFAULT NULL]) RETURN BOOLEAN; 表9 DBE_FILE.FORMAT_WRITE接口参数说明 参数 类型 入参/出参 是否可以为空 描述 file INTEGER IN 否 通过OPEN打开的文件句柄。 format TEXT IN 是 一个要进行格式化的字符串包含，文本和格式符\n和%s。 [arg1. . .arg6] TEXT IN 是 从1到6个可选的参数串，参数和格式化字符的位置是一一对应的，如果存在格式化字符而没有提供参数，会使用空串来替代%s。 DBE_FILE.GET_RAW 该函数用于从打开的文件描述符中读取二进制数据，从r中返回。 DBE_FILE.GET_RAW函数原型为： 1 2 3 4 5 DBE_FILE.GET_RAW ( file IN INTEGER, r OUT RAW, length IN INTEGER DEFAULT NULL) RETURN RAW; 表10 DBE_FILE.GET_RAW接口参数说明 参数 类型 入参/出参 是否可以为空 描述 file INTEGER IN 否 通过OPEN打开的文件句柄。 r RAW OUT 否 输出的二进制数据 length INTEGER IN 是 要读取文件的长度，默认值为NULL，读取文件中所有数据，最大长度为1G。 DBE_FILE.PUT_RAW 函数DBE_FILE.PUT_RAW用于向文件对应的缓冲区中写入RAW类型数据。 DBE_FILE.PUT_RAW函数原型为： 1 2 3 4 5 DBE_FILE.PUT_RAW ( file IN INTEGER, r IN RAW, flush IN BOOLEAN DEFAULT FALSE) RETURN BOOLEAN; 表11 DBE_FILE.PUT_RAW接口参数说明 参数 类型 入参/出参 是否可以为空 描述 file INTEGER IN 否 通过OPEN打开的文件句柄。 r RAW IN 否 输出的二进制数据 说明： 对于写操作，会检测写入文件类型，如果为elf类型文件，会报错退出。 flush BOOLEAN IN 是 是否flush到文件中，默认为false。 DBE_FILE.FLUSH 函数DBE_FILE.FLUSH将缓冲区中的数据写入到物理文件中，缓存中的数据必须要有一个行终结符。该函数可以将缓冲区的数据及时写入到对应的物理文件中。 DBE_FILE.FLUSH函数原型为： 1 2 3 DBE_FILE.FLUSH ( file IN INTEGER) RETURN VOID; 表12 DBE_FILE.FLUSH接口参数说明 参数 类型 入参/出参 是否可以为空 描述 file INTEGER IN 否 一个打开的文件句柄。 DBE_FILE.CLOSE 函数DBE_FILE.CLOSE用于关闭一个打开的文件句柄，当调用这个函数的时候，如果还有等待写入的缓存的数据，可能会收到异常信息。 DBE_FILE.CLOSE函数原型为： 1 2 3 DBE_FILE.CLOSE ( file IN INTEGER )RETURN INTEGER; 表13 DBE_FILE.CLOSE接口参数说明 参数 类型 入参/出参 是否可以为空 描述 file INTEGER IN 否 通过OPEN打开的文件句柄。 DBE_FILE.CLOSE_ALL 函数DBE_FILE.CLOSE_ALL关闭一个会话中打开的所有的文件句柄，可用于紧急的清理操作。 DBE_FILE.CLOSE_ALL函数原型为： 1 2 DBE_FILE.CLOSE_ALL() RETRUN VOID; 表14 DBE_FILE.CLOSE_ALL接口参数说明 参数 描述 无 无 DBE_FILE.REMOVE 函数DBE_FILE.REMOVE删除一个磁盘文件，使用的时候需要有充分的权限。 DBE_FILE.REMOVE函数原型为： 1 2 3 4 DBE_FILE.REMOVE ( dir IN VARCHAR2, file_name IN VARCHAR2) RETURN VOID; 表15 DBE_FILE.REMOVE接口参数说明 参数 类型 入参/出参 是否可以为空 描述 dir VARCHAR2 IN 否 文件的目录位置，这个字符串是一个目录对象名。 说明： 文件目录的位置，需要添加到系统表PG_DIRECTORY中，如果传入的路径和PG_DIRECTORY中的路径不匹配，会报路径不存在的错误，下面的涉及location作为参数的函数也是同样的情况。 在打开guc参数safe_data_path时，用户只能通过高级包读写safe_data_path指定文件路径下的文件。 file_name VARCHAR2 IN 否 文件名。 DBE_FILE.RENAME 函数DBE_FILE.RENAME重命名一个磁盘文件，类似Unix的mv指令。 DBE_FILE.RENAME函数原型为： 1 2 3 4 5 6 7 DBE_FILE.RENAME ( src_dir IN VARCHAR2, src_file_name IN VARCHAR2, dest_dir IN VARCHAR2, dest_file_name IN VARCHAR2, overwrite IN BOOLEAN DEFAULT FALSE) RETURN VOID; 表16 DBE_FILE.RENAME接口参数说明 参数 类型 入参/出参 是否可以为空 描述 src_dir VARCHAR2 IN 否 源文件的目录位置（大小写敏感）。 说明： 文件目录的位置，需要添加到系统表PG_DIRECTORY中，如果传入的路径和PG_DIRECTORY中的路径不匹配，会报路径不存在的错误，下面的涉及location作为参数的函数也是同样的情况。 在打开guc参数safe_data_path时，用户只能通过高级包读写safe_data_path指定文件路径下的文件。 src_file_name VARCHAR2 IN 否 要进行命名的源文件。 dest_dir VARCHAR2 IN 否 目的目录位置（大小写敏感）。 说明： 文件目录的位置，需要添加到系统表PG_DIRECTORY中，如果传入的路径和PG_DIRECTORY中的路径不匹配，会报路径不存在的错误，下面的涉及location作为参数的函数也是同样的情况。 在打开guc参数safe_data_path时，用户只能通过高级包读写safe_data_path指定文件路径下的文件。 dest_file_name VARCHAR2 IN 否 新的文件名。 overwrite BOOLEAN IN 是 是否重写，参数指定为空或者不指定时表示不重写。在不重写的情况下，如果目的目录下已存在同名文件会报错。 DBE_FILE.COPY 函数DBE_FILE.COPY复制一个连续区域的内容到一个新创建的文件中，如果忽略了start_line和end_line会复制整个文件。 DBE_FILE.COPY函数原型为： 1 2 3 4 5 6 7 8 DBE_FILE.COPY ( src_dir IN VARCHAR2, src_file_name IN VARCHAR2, dest_dir IN VARCHAR2, dest_file_name IN VARCHAR2, start_line IN INTEGER DEFAULT 1, end_line IN INTEGER DEFAULT NULL) RETURN VOID; 表17 DBE_FILE.COPY接口参数说明 参数 类型 入参/出参 是否可以为空 描述 src_dir VARCHAR2 IN 否 源文件所在的目录。 说明： 文件目录的位置，需要添加到系统表PG_DIRECTORY中，如果传入的路径和PG_DIRECTORY中的路径不匹配，会报路径不存在的错误，下面的涉及location作为参数的函数也是同样的情况。 在打开guc参数safe_data_path时，用户只能通过高级包读写safe_data_path指定文件路径下的文件。 src_file_name VARCHAR2 IN 否 要拷贝的源文件。 dest_dir VARCHAR2 IN 否 目的文件所在的目录。 说明： 文件目录的位置，需要添加到系统表PG_DIRECTORY中，如果传入的路径和PG_DIRECTORY中的路径不匹配，会报路径不存在的错误，下面的涉及location作为参数的函数也是同样的情况。 在打开guc参数safe_data_path时，用户只能通过高级包读写safe_data_path指定文件路径下的文件。 dest_file_name VARCHAR2 IN 否 目的文件名。 说明： 对于写操作，会检测写入文件类型，如果为elf类型文件，会报错退出。 start_line INTEGER IN 否 拷贝开始的行号，默认是1。 end_line INTEGER IN 是 拷贝结束的行号，默认是NULL，如果是NULL，则指定到文件尾。 DBE_FILE.GET_ATTR 函数DBE_FILE.GET_ATTR读取并返回一个磁盘文件的属性。 DBE_FILE.GET_ATTR函数原型为： 1 2 3 4 5 6 DBE_FILE.GET_ATTR( location IN text, filename IN text, OUT fexists boolean, OUT file_length bigint, OUT block_size integer); 表18 DBE_FILE.GET_ATTR接口参数说明 参数 类型 入参/出参 是否可以为空 描述 location TEXT IN 否 文件所在的目录。 说明： 文件目录的位置，需要添加到系统表PG_DIRECTORY中，如果传入的路径和PG_DIRECTORY中的路径不匹配，会报路径不存在的错误，下面的涉及location作为参数的函数也是同样的情况。 在打开guc参数safe_data_path时，用户只能通过高级包读写safe_data_path指定文件路径下的文件。 filename TEXT IN 否 文件名。 fexists BOOLEAN OUT 否 文件是否存在。 file_length BIGINT OUT 否 文件的字节长度，如果文件不存在返回NULL。 block_size INTEGER OUT 否 文件系统的块大小（单位字节），如果文件不存在返回NULL。 DBE_FILE.SEEK 函数DBE_FILE.SEEK根据用户指定的字节数向前或者向后调整文件指针的位置。 DBE_FILE.SEEK函数原型为： 1 2 3 4 5 DBE_FILE.SEEK ( file IN INTEGER, absolute_start IN BIGINT DEFAULT NULL, relative_start IN BIGINT DEFAULT NULL) RETURN VOID; 表19 DBE_FILE.SEEK接口参数说明 参数 类型 入参/出参 是否可以为空 描述 file INTEGER IN 否 通过OPEN打开的文件句柄。 absolute_start BIGINT IN 是 文件偏移的绝对位置，默认值为NULL。 relative_start BIGINT IN 是 文件偏移的相对位置。如果这个值是正数，向前偏移；如果是负数，向后偏移；默认值为NULL。如果和absolute_start参数同时指定，以absolute_start参数为准。 DBE_FILE.GET_POS 函数DBE_FILE.GET_POS以字节为单位返回文件当前的偏移量。 DBE_FILE.FGETPOS函数原型为： 1 2 3 DBE_FILE.GET_POS ( file IN INTEGER) RETURN BIGINT; 表20 DBE_FILE.GET_POS接口参数说明 参数 类型 入参/出参 是否可以为空 描述 file INTEGER IN 否 通过OPEN打开的文件句柄。

PG_STAT_BGWRITER PG_STAT_BGWRITER视图显示后端写进程活动的统计信息。 表1 PG_STAT_BGWRITER字段 名称 类型 描述 checkpoints_timed bigint 定期执行的检查点数。 checkpoints_req bigint 主动执行的检查点数。 checkpoint_write_time double precision 将文件写入到磁盘时，在检查点处理部分花费的时间总量，以毫秒为单位。 checkpoint_sync_time double precision 将文件同步到磁盘时，在检查点处理部分花费的时间总量，以毫秒为单位。 buffers_checkpoint bigint 检查点写入的缓冲区的数量。 buffers_clean bigint 后端写进程写入的缓冲区的数量。 maxwritten_clean bigint 后端写进程因写入的缓冲区过多导致的清理扫描停止的次数。 buffers_backend bigint 后端直接写入的缓冲区的数量。 buffers_backend_fsync bigint 后端自己执行fsync调用的次数 （通常情况下，即使后端自己执行了这些写入动作，后端写进程也会再处理一次）。 buffers_alloc bigint 分配的缓冲区数量。 stats_reset timestamp with time zone 这些统计被重置的时间。 父主题： 系统视图

删除表中数据 在使用表的过程中，可能会需要删除已过期的数据，删除数据必须从表中整行的删除。 SQL不能直接访问独立的行，只能通过声明被删除行匹配的条件进行。如果表中有一个主键，用户可以指定准确的行。用户可以删除匹配条件的一组行或者一次删除表中的所有行。 使用DELETE命令删除行，如果删除表customer_t1中所有c_customer_sk为3869的记录： 1 openGauss=# DELETE FROM customer_t1 WHERE c_customer_sk = 3869; 如果执行如下命令之一，会删除表中所有的行。 1 openGauss=# DELETE FROM customer_t1; 1 2 或： openGauss=# TRUNCATE TABLE customer_t1; 全表删除的场景下，建议使用truncate，不建议使用delete。 删除创建的表： 1 openGauss=# DROP TABLE customer_t1; 父主题： 创建和管理表

WAIT_EVENTS WAIT_EVENTS显示当前节点wait event的相关统计信息。或从视图wait_event_info中查看系统中所有的事件列表。关于每种事务锁对业务的影响程度，请参考LOCK语法小节的详细描述。 表1 WAIT_EVENTS字段 名称 类型 描述 nodename text 节点名称。 type text event类型。 event text event名称。 wait bigint 等待次数。 failed_wait bigint 失败的等待次数。 total_wait_time bigint 总等待时间（单位：微秒）。 avg_wait_time bigint 平均等待时间（单位：微秒）。 max_wait_time bigint 最大等待时间（单位：微秒）。 min_wait_time bigint 最小等待时间（单位：微秒）。 last_updated timestamp with time zone 最后一次更新该事件的时间。 父主题： Wait Events

语法格式 LOCK [ TABLE ] {[ ONLY ] name [, ...]| {name [ * ]} [, ...]} [ IN {AC CES S SHARE | ROW SHARE | ROW EXCLUSIVE | SHARE UPDATE EXCLUSIVE | SHARE | SHARE ROW EXCLUSIVE | EXCLUSIVE | ACCESS EXCLUSIVE} MODE ] [ NOWAIT ][CANCELABLE];

参数说明 表1 冲突的锁模式 请求的锁模式/当前锁模式 ACCESS SHARE ROW SHARE ROW EXCLUSIVE SHARE UPDATE EXCLUSIVE SHARE SHARE ROW EXCLUSIVE EXCLUSIVE ACCESS EXCLUSIVE ACCESS SHARE - - - - - - - X ROW SHARE - - - - - - X X ROW EXCLUSIVE - - - - X X X X SHARE UPDATE EXCLUSIVE - - - X X X X X SHARE - - X X - X X X SHARE ROW EXCLUSIVE - - X X X X X X EXCLUSIVE - X X X X X X X ACCESS EXCLUSIVE X X X X X X X X LOCK的参数说明如下所示： name 要锁定的表的名称，可以有模式修饰。 LOCK TABLE命令中声明的表的顺序就是上锁的顺序。 取值范围：已存在的表名。 ONLY 如果指定ONLY，只有该表被锁定。如果没有声明，该表和他的所有子表将都被锁定。 ACCESS SHARE ACCESS锁只允许对表进行读取，而禁止对表进行修改。所有对表进行读取而不修改的SQL语句都会自动请求这种锁。例如，SELECT命令会自动在被引用的表上请求一个这种锁。 ROW SHARE ROW SHARE锁允许对表进行并发读取，禁止对表进行其他操作。 SELECT FOR UPDATE和SELECT FOR SHARE命令会自动在目标表上请求ROW SHARE锁（且所有被引用但不是FOR SHARE/FOR UPDATE的其他表上，还会自动加上ACCESS SHARE锁）。 对于分区表，SELECT FOR SHARE操作还会在DN上获取partition对象的ROW EXCLUSIVE锁进行并发控制。 ROW EXCLUSIVE 与ROW SHARE锁相同，ROW EXCLUSIVE允许并发读取表，但是禁止修改表中数据。UPDATE，DELETE，INSERT命令会自动在目标表上请求这个锁（且所有被引用的其他表上还会自动加上的ACCESS SHARE锁）。通常情况下，所有会修改表数据的命令都会请求表的ROW EXCLUSIVE锁。 SHARE UPDATE EXCLUSIVE 这个模式保护一个表的模式不被并发修改，以及禁止在目标表上执行垃圾回收命令（VACUUM）。 VACUUM（不带FULL选项）、ANALYZE、CREATE INDEX CONCURRENTLY命令会自动请求这样的锁。 SHARE SHARE锁允许并发的查询，但是禁止对表进行修改。 CREATE INDEX（不带CONCURRENTLY）语句会自动请求这种锁。 SHARE ROW EXCLUSIVE SHARE ROW EXCLUSIVE锁禁止对表进行任何的并发修改，而且是独占锁，因此一个会话中只能获取一次。 任何SQL语句都不会自动请求这个锁模式。 EXCLUSIVE EXCLUSIVE锁允许对目标表进行并发查询，但是禁止任何其他操作。 这个模式只允许并发加ACCESS SHARE锁，也就是说，只有对表的读动作可以和持有这个锁模式的事务并发执行。 任何SQL语句都不会在用户表上自动请求这个锁模式。然而在某些操作的时候，会在某些系统表上请求它。 ACCESS EXCLUSIVE 这个模式保证其所有者（事务）是可以访问该表的唯一事务。 ALTER TABLE，DROP TABLE，TRUNCATE，REINDEX，CLUSTER，VACUUM FULL命令会自动请求这种锁。 在LOCK TABLE命令没有明确声明需要的锁模式时，它是缺省锁模式。 NOWAIT 声明LOCK TABLE不去等待任何冲突的锁释放，如果无法立即获取该锁，该命令退出并且发出一个错误信息。 在不指定NOWAIT的情况下获取表级锁时，如果有其他互斥锁存在的话，则等待其他锁的释放。 CANCELABLE 通过指定该参数允许等锁线程给持锁线程和等锁线程发送CANCEL信号。 只允许重分布工具使用，其它用户使用将报错。

注意事项 LOCK TABLE只能在一个事务块的内部有用，因为锁在事务结束时就会被释放。出现在任意事务块外面的LOCK TABLE都会报错。 如果没有声明锁模式，缺省为最严格的模式ACCESS EXCLUSIVE。 LOCK TABLE ... IN ACCESS SHARE MODE需要在目标表上有SELECT权限。所有其他形式的LOCK需要UPDATE或DELETE权限。 没有UNLOCK TABLE命令，锁总是在事务结束时释放。 LOCK TABLE只处理表级的锁，因此那些带“ROW”字样的锁模式都是有歧义的。这些模式名称通常可理解为用户试图在一个被锁定的表中获取行级的锁。同样，ROW EXCLUSIVE模式也是一个可共享的表级锁。注意，只要是涉及到LOCK TABLE，所有锁模式都有相同的语意，区别仅在于规则中锁与锁之间是否冲突，规则请参见表1。 如果没有打开xc_maintenance_mode参数，那么对系统表申请ACCESS EXCLUSIVE级别锁将报错。 自动CANCEL业务接口只允许重分布工具使用。

功能描述 LOCK TABLE获取表级锁。 GaussDB在为一个引用了表的命令自动请求锁时，尽可能选择最小限制的锁模式。如果用户需要一种更为严格的锁模式，可以使用LOCK命令。例如，一个应用是在Read Committed隔离级别上运行事务，并且它需要保证表中的数据在事务的运行过程中不被修改。为实现这个目的，则可以在查询之前对表使用SHARE锁模式进行锁定。这样将防止数据不被并发修改，从而保证后续的查询可以读到已提交的持久化的数据。因为SHARE锁模式与任何写操作需要的ROW EXCLUSIVE模式冲突，并且LOCK TABLE name IN SHARE MODE语句将等到所有当前持有ROW EXCLUSIVE模式锁的事务提交或回滚后才能执行。因此，一旦获得该锁，就不会存在未提交的写操作，并且其他操作也只能等到该锁释放之后才能开始。

MY_IND_EXPRESSIONS MY_IND_EXPRESSIONS视图显示当前用户下基于函数的表达式索引的信息。该视图同时存在于PG_CATA LOG 和SYS Schema下。 表1 MY_IND_EXPRESSIONS字段 名称 类型 描述 table_owner character varying(64) 表的所有者。 table_name character varying(64) 表名。 index_owner character varying(64) 索引的所有者。 index_name character varying(64) 索引名。 column_expression text 定义列的基于函数的索引表达式。 column_position smallint 索引中列的位置。 父主题： 系统视图

GS_AUDITING_POLICY_FILTERS GS_AUDITING_POLICY_FILTERS系统表记录统一审计相关的过滤策略相关信息，每条记录对应一个设计策略。需要有系统管理员或安全策略管理员权限才可以访问此系统表。 表1 GS_AUDITING_POLICY_FILTERS字段 名称 类型 描述 oid oid 行标识符（隐含属性，必须明确选择）。 filtertype name 过滤类型。目前值仅为logical_expr。 labelname name 名称。目前值仅为logical_expr。 policyoid oid 所属审计策略的oid，对应审计策略系统表GS_AUDITING_POLICY中的oid。 modifydate timestamp without time zone 创建或修改的最新时间戳。 logicaloperator text 过滤条件的逻辑字符串。 父主题： 系统表

JSON/JSONB支持的函数 array_to_json(anyarray [, pretty_bool]) 描述：返回JSON类型的数组。将一个多维数组组成一个JSON数组。如果pretty_bool为true，将在一维元素之间添加换行符。 返回类型：json 示例： openGauss=# SELECT array_to_json('{{1,5},{99,100}}'::int[]); array_to_json ------------------ [[1,5],[99,100]] (1 row) row_to_json(record [, pretty_bool]) 描述：返回JSON类型的行。如果pretty_bool为true，将在第一级元素之间添加换行符。 返回类型：json 示例： openGauss=# SELECT row_to_json(row(1,'foo')); row_to_json --------------------- {"f1":1,"f2":"foo"} (1 row)

PG_ENUM PG_ENUM系统表包含显示每个枚举类型值和标签的记录。给定枚举类型的内部表示实际上是PG_ENUM里面相关行的OID。 表1 PG_ENUM字段 名称 类型 引用 描述 oid oid - 行标识符（隐含字段，必须明确选择）。 enumtypid oid PG_TYPE.oid 拥有这个枚举值的PG_TYPE记录的OID。 enumsortorder real - 这个枚举值在它的枚举类型中的排序位置。 enumlabel name - 这个枚举值的文本标签。 PG_ENUM行的OID跟着一个特殊规则：偶数的OID保证用和它们的枚举类型一样的排序顺序排序。也就是，如果两个偶数OID属于相同的枚举类型，那么较小的OID必须有较小enumsortorder值。奇数OID需要毫无关系的排序顺序。这个规则允许枚举比较例程在许多常见情况下避开目录查找。创建和修改枚举类型的例程只要可能就尝试分配偶数OID给枚举值。 当创建了一个枚举类型时，它的成员赋予了排序顺序位置1到n。但是随后添加的成员可能会分配enumsortorder的负值或分数值。对这些值的唯一要求是它们要正确的排序和在每个枚举类型中唯一。 父主题： 系统表

gtm_option 参数说明：GTM模式选项，用来指定选用的GTM模式，需要在GTM，CN，DN所有实例上配置，配置的值要一致，共三种模式：GTM模式，GTM-Lite模式，GTM-Free模式。其中GTM模式和GTM-Lite模式要在enable_gtm_free参数设置为off的情况下生效，当前版本暂不支持安装好的集群进行不同GTM模式之间的切换。 取值范围：整型，0~2，0表示GTM模式，1表示GTM-Lite模式，2表示GTM-Free模式。请参考表1中对应设置方法进行设置。 默认值：1

gtm_num_threads 参数说明：当gtm_enable_threadpool线程池功能开启时，用来控制线程池工作线程的个数。 该数值与gtm_max_trans大小相关，不应该超过（gtm_max_trans - 1 - 辅助线程数），其中辅助线程数当前版本为2。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，0~16384之间。 默认值：1024

gtm_krb_server_keyfile 参数说明：kerberos服务端key文件所在位置，需要配置为绝对路径。该文件通常为${GAUSSHOME}/kerberos路径下，以keytab格式结尾，文件名与集群运行所在用户名相同。与上述gtm_authentication_type参数是配对的，当gtm_authentication_type参数修改为gss时，该参数也必须配置为正确路径，否则将影响集群状态。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：字符串类型 默认值：''

alarm_component 参数说明：在对告警做上报时，会进行告警抑制，即同一个实例的同一个告警项在alarm_report_interval（默认值为10s）内不做重复上报。在这种情况下设置用于处理告警内容的告警组件的位置。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：字符串 若前置脚本gs_preinstall中的--alarm-type参数设置为5时，表示未对接第三方组件，告警写入system_alarm日志，此时GUC参数alarm_component的取值为：/opt/huawei/snas/bin/snas_cm_cmd。 若前置脚本gs_preinstall中的--alarm-type参数设置为1时，表示对接第三方组件，此时GUC参数alarm_component的值为第三方组件的可执行程序的绝对路径。 默认值：/opt/huawei/snas/bin/snas_cm_cmd