华为云用户手册

变量作用域 变量的作用域表示变量在代码块中的可访问性和可用性。只有在它的作用域内，变量才有效。 变量必须在declare部分声明，即必须建立BEGIN-END块。块结构也强制变量必须先声明后使用，即变量在过程内有不同作用域、不同的生存期。 同一变量可以在不同的作用域内定义多次，内层的定义会覆盖外层的定义。 在外部块定义的变量，可以在嵌套块中使用。但外部块不能访问嵌套块中的变量。 示例 gaussdb=# DECLARE emp_id INTEGER :=7788; --定义变量并赋值 outer_var INTEGER :=6688; --定义变量并赋值 BEGIN DECLARE emp_id INTEGER :=7799; --定义变量并赋值 inner_var INTEGER :=6688; --定义变量并赋值 BEGIN dbe_output.print_line('inner emp_id ='||emp_id); --显示值为7799 dbe_output.print_line('outer_var ='||outer_var); --引用外部块的变量 END; dbe_output.print_line('outer emp_id ='||emp_id); --显示值为7788 END; / inner emp_id =7799 outer_var =6688 outer emp_id =7788 ANONYMOUS BLOCK EXECUTE

参数说明 cursor_name 将要创建的游标名。 取值范围：遵循数据库对象命名规范。 BINARY 指明游标以二进制而不是文本格式返回数据。 NO SCROLL 声明游标检索数据行的方式。 NO SCROLL：声明该游标不能用于以倒序的方式检索数据行。 未声明：根据执行计划的不同，自动判断该游标是否可以用于以倒序的方式检索数据行。 WITH HOLD WITHOUT HOLD 声明当创建游标的事务结束后，游标是否能继续使用。 WITH HOLD：声明该游标在创建它的事务结束后仍可继续使用。 WITHOUT HOLD：声明该游标在创建它的事务之外不能再继续使用，此游标将在事务结束时被自动关闭。 如果不指定WITH HOLD或WITHOUT HOLD，默认行为是WITHOUT HOLD。 声明为WITH HOLD的游标，在事务结束时，会缓存游标所有数据，若游标数据量较大，此过程耗时可能较长。 query 使用SELECT或VALUES子句指定游标返回的行。 取值范围：SELECT或VALUES子句。 declare_statements 声明变量，包括变量名和变量类型，如“sales_cnt int”。 execution_statements 匿名块中要执行的语句。 取值范围：已存在的函数名称。

属性 游标的属性用于控制程序流程或者了解程序的状态。当运行DML语句时，PL/SQL打开一个内建游标并处理结果，游标是维护查询结果的内存中的一个区域，游标在运行DML语句时打开，完成后关闭。显式游标的属性为： %FOUND布尔型属性：当最近一次读记录时成功返回，则值为TRUE。 %NOTFOUND布尔型属性：当最近一次读记录时失败返回，则值为TRUE。 %ISOPEN布尔型属性：当游标已打开时返回TRUE。 %ROWCOUNT数值型属性：返回已从游标中读取的记录数。

带索引的集合类型 该集合类型将下标和对应成员值以键值对的方式存储在HASH表中，对该类型变量的所有操作实际就是对HASH表的操作。用户无需自行扩展或释放存储空间，仅需通过赋值或delete方式进行存储和删除成员。集合相关操作、说明如下： 类型定义 索引集合类型定义需同时指定成员类型data_type和下标类型indexby_type，其中下标类型仅支持integer和varchar。 变量声明和初始化 索引集合类型声明后存在三种初始化场景：未初始化、初始化为空、初始化指定下标和成员值。其中未初始化和初始化为空场景对变量的效果一致。未初始化或初始化为空后变量不为NULL，后续都可以对变量直接进行赋值。初始化指定下标和成员值场景会将指定的下标和成员值以键值对的形式保存到变量中。 变量赋值 索引集合类型变量赋值分为两种：成员赋值和整体赋值。成员赋值可通过指定下标方式对某个成员赋值，若该成员不存在则直接赋值，若存在则刷新该成员值。整体赋值则会将被赋值变量中原有成员都清空后重新保存新的成员值。整体赋值场景不能给变量赋NULL值，否则报错。 变量取值 通过指定下标方式可获取变量中对应下标的成员值，若通过下标找不到该成员则会返回“no data found”的错误信息。 非兼容A模式下（参数sql_compatibility值不为A），不支持创建带索引集合类型。 支持在匿名块、存储过程、自定义函数、package中定义带索引集合类型，其作用域各不相同。不支持在schema中定义带索引集合类型。 NOT NULL只支持语法不支持功能。 当data_type为VARCHAR、NUMERIC等可以定义长度和精度的类型时，要校验集合的元素长度或者将元素转换成对应的精度，需要开启tableof_elem_constraints参数（设置behavior_compat_options参数值为tableof_elem_constraints）。CHAR、VARCHAR、NUMERIC、FLOAT和NUMBER等元素类型的范围约束语法创建集合类型，例如：“type t1 is table of numeric(5) index by int; ”只支持语法创建，不支持元素的范围约束功能，功能等同于“type t1 is table of numeric index by int;”。 data_type为数组类型时，数组类型的元素长度校验或精度转换也受参数tableof_elem_constraints是否开启影响。 通过数组类型转换成的集合类型的值不支持对元素长度校验或精度转换。 data_type可以为基础数据类型，或存储过程内定义的record类型，集合类型，数组类型，不支持ref cursor类型。 indexby_type仅支持INTEGER和VARCHAR。 indexby_type为varchar时，开启参数tableof_elem_constraints后在对带索引集合类型赋值时会校验index值的长度，校验行为不受char_coerce_compat参数是否开启影响，index长度大于定义长度则报错；不开启参数tableof_elem_constraints则不会对索引值进行长度校验。 未初始化的带索引集合类型变量非NULL。 带索引集合类型变量不能赋NULL值，否则报错。 带索引集合类型变量作为入参不能赋NULL值或''。 不同的带索引集合类型的变量不能相互赋值。即使成员类型和下标类型相同，但集合类型名称不同，也是不同的集合类型。如： TYPE t1 IS TABLE OF int index by int; 和 TYPE t2 IS TABLE OF int index by int; 定义的两个集合类型，t1和t2是不同的集合类型，以其定义的变量不支持相互赋值（作为成员类型时该约束不保证生效，赋值逻辑受父类型影响）。 带索引集合类型不支持关系运算和算数运算操作。 select ... bulk collect into 方式赋值带索引集合类型变量时，只支持下标为INTEGER类型的集合类型，下标为VARCHAR类型集合不支持。 支持带索引集合类型变量作为函数的参数和返回值，此时要求参数或者返回值的类型是在package中定义的集合类型。 带索引的集合作为函数入参时，可以传入对应子元素类型相同的数组类型作为入参，不支持多维数组，不支持索引数据类型为VARCHAR（过时的方法，不建议使用该功能。可执行“set behavior_compat_options = 'disable_rewrite_nesttable';”禁用）。 类型构造器目前仅支持集合类型，其参数个数的上限与用户自定义函数参数个数上限相同。对于带索引的集合类型，构造器在使用时索引的值仅支持为常量。 不支持对XML类型数据操作。 集合类型以及嵌套集合的类型不支持作为表中的一列来创建表。 集合类型的构造器不支持浮点数以及表达式作为下标。 在匿名块中定义的集合类型，匿名块执行ROLLBACK或发生EXCEPTION后，集合类型将无法继续使用。 执行set enable_recordtype_check_strict = on;后，成员是record类型，且record类型有列具有not null属性或defalut属性，在存储过程或PACKAGE编译时会报错。

参数说明 server_name server的名称。 取值范围：长度必须小于等于63字节。 fdw_name 指定外部数据封装器的名称。 取值范围：dist_fdw，log_fdw，file_fdw。其中log_fdw和file_fdw仅作语法兼容，可以创建外表，无实际使用意义，不做额外使用说明。 OPTIONS ( { option_name ' value ' } [, ...] ) 这个子句为服务器指定选项。这些选项通常定义该服务器的连接细节，但是实际的名称和值取决于该服务器的外部数据包装器。 用于指定外部服务器的各类参数，详细的参数说明如下所示。 encrypt 是否对数据进行加密，该参数仅支持type为OBS时设置。默认值为on。 取值范围： on表示对数据进行加密，使用HTTPS协议通信。 off表示不对数据进行加密，使用HTTP协议通信。 access_key OBS访问协议对应的AK值（OBS云服务界面由用户获取）。该参数仅支持type为OBS时设置。 secret_access_key OBS访问协议对应的SK值（OBS云服务界面由用户获取）。该参数仅支持type为OBS时设置。 除了libpq支持的连接参数外，还额外提供以下参数： fdw_startup_cost 执行一个外表扫描时的启动耗时估算。这个值通常包含建立连接、远端对请求的分析和生成计划的耗时。默认值为100。取值范围为大于0的实数。 fdw_typle_cost 在远端服务器上对每一个元组进行扫描时的额外消耗。这个值通常表示数据在server间传输的额外消耗。默认值为0.01。取值范围为大于0的实数。

示例 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 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 --创建一个表tb_for_label。 gaussdb=# CREATE TABLE tb_for_label(col1 text, col2 text, col3 text); --基于表创建资源标签。 gaussdb=# CREATE RESOURCE LABEL IF NOT EXISTS table_label add TABLE(public.tb_for_label); --再次创建已存在的表资源标签，对比加参数IF NOT EXISTS与不加IF NOT EXISTS参数的区别。 gaussdb=# CREATE RESOURCE LABEL IF NOT EXISTS table_label add TABLE(public.tb_for_label); NOTICE: table_label label already defined, skipping CREATE RESOURCE LABEL gaussdb=# CREATE RESOURCE LABEL table_label add TABLE(public.tb_for_label); ERROR: table_label label already defined --基于列创建资源标签。 gaussdb=# CREATE RESOURCE LABEL IF NOT EXISTS column_label add COLUMN(public.tb_for_label.col1); --创建一个模式schema_for_label。 gaussdb=# CREATE SCHEMA schema_for_label; --基于模式创建资源标签。 gaussdb=# CREATE RESOURCE LABEL IF NOT EXISTS schema_label add SCHEMA(schema_for_label); --创建一个视图view_for_label。 gaussdb=# CREATE VIEW view_for_label AS SELECT 1; --基于视图创建资源标签。 gaussdb=# CREATE RESOURCE LABEL IF NOT EXISTS view_label add VIEW(view_for_label); --创建一个函数func_for_label。 gaussdb=# CREATE FUNCTION func_for_label RETURNS TEXT AS $$ SELECT col1 FROM tb_for_label; $$ LANGUAGE SQL; --基于函数创建资源标签。 gaussdb=# CREATE RESOURCE LABEL IF NOT EXISTS func_label add FUNCTION(func_for_label); --删除表资源标签table_label。 gaussdb=# DROP RESOURCE LABEL IF EXISTS table_label; --删除列资源资源标签column_label。 gaussdb=# DROP RESOURCE LABEL IF EXISTS column_label; --删除函数资源标签func_for_label。 gaussdb=# DROP FUNCTION func_for_label; --删除视图资源标签view_for_label。 gaussdb=# DROP VIEW view_for_label; --删除模式资源标签schema_for_label。 gaussdb=# DROP SCHEMA schema_for_label; --删除表tb_for_label。 gaussdb=# DROP TABLE tb_for_label;

wal_receiver_status_interval 参数说明：设置WAL日志接收线程的状态通知给主机的最大时间间隔。 该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。 取值范围：整型，0 ~ INT_MAX / 1000 ，单位为秒。 默认值：5s 当该参数设置为0时，表示关闭备机向主机反馈日志接收位置等信息，可能会导致主机事务提交阻塞、switchover操作失败等异常现象。正常业务场景，不建议将该参数设置为0。

standby_force_recycle_ratio 参数说明：开启极致RTO功能后，备机读相关文件的触发强制回收的比例。当base page文件总大小超过max_standby_base_page_size* standby_force_recycle_ratio，或者lsn info文件总大小超过max_standby_lsn_info_size* standby_force_recycle_ratio时，触发强制回收，会有查询被取消。当standby_force_recycle_ratio = 0时，不会启动强制回收，max_standby_base_page_size和max_standby_lsn_info_size也不会生效。 该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。 取值范围：双精度浮点类型，0.0～1.0。 默认值：0.8

standby_max_query_time 参数说明：开启极致RTO功能后，支持的备机上查询的最大时间，超过该时间会被取消。注：何时取消查询受回收线程的时间间隔参数standby_recycle_interval和查询取快照的时间影响，因此备机上查询的实际执行时间要大于该参数。 该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。 取值范围：整型，0~86400‬，单位是秒（s）。 默认值：600

max_standby_archive_delay 参数说明：当开启双机热备模式时，如果备机正处理归档WAL日志数据，这时进行查询就会产生冲突，此参数就是设置备机取消查询之前所等待的时间。当前版本设置暂不生效，统一由参数max_standby_streaming_delay控制。 参数类型：整型 参数单位：毫秒 取值范围：-1 ~ 2147483647 -1表示允许备机一直等待冲突的查询完成。 默认值：3s（即3000ms） 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：建议设置为默认值。

hot_standby_feedback 参数说明：设置是否允许将备机上执行查询的结果反馈给主机，这可以避免查询冲突。 该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。 取值范围：布尔型 on表示允许将备机上执行查询的最小事务号反馈给主机。 off表示不允许将备机上执行查询的最小事务号反馈给主机。 默认值：off 当该参数为on时，主机的旧版本数据的清理会受限于备机正在读的事务，即主机只允许清理小于备机反馈回来的事务所作的更改。 所以，若该参数开启时，会影响主机的性能。若备机回放与查询冲突，出现查询报错，建议适当调大max_standby_streaming_delay。

max_standby_streaming_delay 参数说明：当开启双机热备模式时，如果备机正通过流复制接收WAL日志数据，这时进行查询就会产生冲突，这个参数就是设置备机取消查询之前所等待的时间。当参数值较大，或业务压力大时，概率出现等待事务回放落盘的报错。 该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。 -1表示允许备机一直等待冲突的查询完成。在开启串行或并行回放的场景下，当检测到查询线程与回放线程已处于死锁状态时，仍会通过取消查询来避免阻塞回放。 取值范围：整型（毫秒），范围：-1~INT_MAX。 默认值：3s（即3000ms）

walrcv_writer_crc_check_level 参数说明：支持流式容灾场景下，主备数据库内备机侧的xlog校验，默认仅在灾备数据库内开启。 参数类型：整型 参数单位：无 取值范围：0~3 0：关闭校验。 1：灾备数据库内校验生效。 2：主数据库内备机侧的校验生效。 3：主数据库内的备机和灾备数据库内节点全部生效。 默认值：1 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。

示例 --创建系统管理员用户。 gaussdb=# CREATE USER sysadmin WITH SYSADMIN PASSWORD '********'; --切换管理员用户。 gaussdb=# \c - sysadmin --创建同义词t1。 gaussdb=# CREATE OR REPLACE SYNONYM t1 FOR ot.t1; --创建新用户u1。 gaussdb=# CREATE USER u1 PASSWORD '********'; --给新用户赋权限。 gaussdb=# GRANT ALL ON SCHEMA sysadmin TO u1; --修改同义词t1的owner为u1。 gaussdb=# ALTER SYNONYM t1 OWNER TO u1; --删除同义词t1。 gaussdb=# DROP SYNONYM t1; --收回用户u1权限。 gaussdb=# REVOKE ALL ON SCHEMA sysadmin FROM u1; --删除用户u1。 gaussdb=# DROP USER u1; --切换到初始用户init_user，请使用真实的初始用户名称替换init_user。 gaussdb=# \c - init_user --删除用户sysadmin。 gaussdb=# DROP USER sysadmin;

算子级调优介绍 一个查询语句要经过多个算子步骤才会输出最终的结果。由于个别算子耗时过长导致整体查询性能下降的情况比较常见。这些算子是整个查询的瓶颈算子。通用的优化手段是EXPLAIN ANALYZE/PERFORMANCE命令查看执行过程的瓶颈算子，然后进行针对性优化。 如下面的执行过程信息中，Hashagg算子的执行时间占总时间的：(51016-13535)/ 56476 ≈66%，此处Hashagg算子就是这个查询的瓶颈算子，在进行性能优化时应当优先考虑此算子的优化。

操作步骤 连接数据库，具体操作请参见通过gsql连接实例章节。 查看数据库GUC参数当前取值。 方法一：使用SHOW命令。 使用如下命令查看单个参数： 1 gaussdb=# SHOW server_version; server_version显示数据库版本信息的参数。 使用如下命令查看所有参数： 1 gaussdb=# SHOW ALL; 方法二：使用pg_settings视图。 使用如下命令查看单个参数： 1 gaussdb=# SELECT * FROM pg_settings WHERE NAME='server_version'; 使用如下命令查看所有参数： 1 gaussdb=# SELECT * FROM pg_settings;

application_name 参数说明：当前连接请求当中，所使用的客户端名称。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。但是需要注意的是，客户端连接后该参数会被设为客户端名称，且设置为客户端级别，所以只有设置会话级别的参数会生效，其他方式都由于级别低于客户端级别而不会生效。 在备机请求主机进行日志复制时，如果该参数非空串，那么会被用来作为备机在主机上的流复制槽名字。此时，如果该参数长度超过61个字节，那么流复制槽名字只会截取使用前61个字节的字符。 取值范围：字符串。 默认值：空字符串（连接到后端的应用名，以实际安装为准）

sysadmin_reserved_connections 参数说明：为管理员用户预留的最少连接数，不建议设置过大。该参数和max_connections参数配合使用，管理员用户的最大连接数等于max_connections + sysadmin_reserved_connections。 当启用线程池功能时，若线程池占满将形成处理瓶颈，导致管理员预留连接无法正常建立；作为逃生手段，此时可使用gsql通过主端口+1端口号连入，清理无用会话，即可正常连入。 当管理员预留连接数全部被使用后，新建连接将失败，此时只能通过重启数据库来恢复，所以需要谨慎使用该预留连接数。 参数类型：整型 参数单位：无 取值范围：最小值为0，最大值为MIN(262143, max_connections)，max_connections的计算方法见上文。 默认值：3 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：无 设置不当的风险与影响：无

plat_compat_server_port 参数说明：M-Compatibility模式数据库行为配置项。该参数用于设置协议侦听的TCP端口号。 参数类型：整型 参数单位：无 取值范围：1024-65536 默认值：默认值：65536，表示不启动监听端口。 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：默认值65536，表示不启动监听端口，1024-65535属于有效监听端口，请设置为未被使用的端口。

unix_socket_directory 参数说明：设置 GaussDB 服务器侦听客户端连接的Unix域套接字目录。 参数类型：字符串 参数单位：无 取值范围：合法目录路径。 该参数的取值长度限制于操作系统的最大目录路径长度，超过该限制将会导致Unix-domain socket path "xxx" is too long的问题。 默认值：空字符串（实际值由安装时配置文件指定） 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：无 设置不当的风险与影响：若误设置出错（包括长度超过限制、非法目录等），会影响进程正常拉起，可以通过启动日志定界。

service_reserved_connections 参数说明：为后台运维用户（带有persistence属性）预留的最少连接数，不建议设置过大。该参数和max_connections参数配合使用，运维用户的最大连接数等于max_connections + service_reserved_connections。 参数类型：整型 参数单位：无 取值范围：最小值为0，最大值为262143。 默认值：10 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。如果设置过小，会导致在max_connections满的情况下，运维用户（带有persistence属性）无法连接数据库，作业无法正常执行。 设置不当的风险与影响：无

max_inner_tool_connections 参数说明：允许和数据库连接的工具的最大并发连接数。此参数会影响GaussDB的工具连接并发能力。 参数类型：整型 参数单位：无 取值范围：最小值为1，最大值的计算公式为：262143 - job_queue_processes - autovacuum_max_workers - max_connections - max_concurrent_autonomous_transactions - AUXILIARY_BACKENDS - AV_LAUNCHER_PRO CS - min(max(max_connections/4,64),1024)。job_queue_processes、autovacuum_max_workers、max_connections和max_concurrent_autonomous_transactions的值与相应的GUC参数的设置有关；AUXILIARY_BACKENDS为预留辅助线程数，固定为20；AV_LAUNCHER_PROCS为预留autovacuum的launcher线程数，固定为2。 默认值：50（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内存）；10（4核CPU/16G内存） 如果该默认值超过内核支持的最大值（在执行gs_initdb的时候判断），系统会提示错误。 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：数据库主节点中此参数建议保持默认值。增大此参数可能会导致GaussDB要求更多的SystemV共享内存或者信号量，可能超过操作系统缺省配置的最大值。这种情况下，请酌情对数值加以调整。 设置不当的风险与影响：无

unix_socket_permissions 参数说明：设置Unix域套接字的访问权限。 Unix域套接字使用普通的Unix文件系统权限集。这个参数的值应该是数值的格式（chmod和umask命令可接受的格式）。如果使用自定义的八进制格式，数字必须以0开头。 建议设置为0770（只有当前连接数据库的用户和同组的人可以访问）或者0700（只有当前连接数据库的用户自己可以访问，同组或者其他人都没有权限）。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：0000-0777 默认值：0700 在Linux中，文档具有十个属性，其中第一个属性为文档类型，后面九个为权限属性，分别为Owner、Group及Others这三个组别的read、write、execute属性。 文档的权限属性分别简写为r、w、x，这九个属性三个为一组，也可以使用数字来表示文档的权限，对照表如下： r：4 w: 2 x：1 -：0 同一组（owner/group/others）的三个属性是累加的。 例如，-rwxrwx---表示这个文档的权限为： owner=rwx=4+2+1=7 group=rwx=4+2+1=7 others =---=0+0+0=0 所以其权限为0770。

check_disconnect_query 参数说明：当客户端异常断连（如JDBC触发socketTimeout、libpq触发rwtimeout且关闭连接、运行业务过程中客户端进程终止等）后，该参数控制GaussDB服务端语句是否终止执行。 参数类型：布尔型 参数单位：无 取值范围： on：表示当客户端异常断连后，GaussDB服务端终止运行对应的语句。 off：表示当客户端异常断连后，GaussDB服务端不会终止运行对应的语句。 默认值：on 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。

port 参数说明：GaussDB服务侦听的TCP端口号。 参数类型：整型 参数单位：无 取值范围：1～65535 设置端口号时，请设置一个未被占用的端口号。设置多个实例的端口号，不可冲突。 1~1023为操作系统保留端口号，请不要使用。 通过配置文件安装数据库实例时，配置文件中的端口号需要注意通信矩阵预留端口。如：DN还需保留dataPortBase+1作为内部工具使用端口。故数据库实例安装阶段，port最大值为：DN可设置65529，同时需要保证端口号不冲突。 默认值：5432（实际值由安装时的配置文件指定） 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：该参数由安装时的配置文件指定，请勿轻易修改，否则修改后会影响数据库正常通信。

参数说明 VERBOSE 可选。启用显示进度信息。 table_name 表名称。 取值范围：已存在的表名称。 [ USING index_name ] 索引名称。 取值范围：已存在的索引名称。 第一次对表进行聚簇排序时必须指定index_name，后续再次对表进行聚簇排序时不指定index_name，将会按照已有记录对表进行聚簇排序。 partition_name 分区名称。 取值范围：已存在的分区名称。

示例 对表进行聚簇排序： 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 26 27 28 --建表并向表中插入数据。 gaussdb=# CREATE TABLE test_c1(id int, name varchar(20)); gaussdb=# CREATE INDEX idx_test_c1_id ON test_c1(id); gaussdb=# INSERT INTO test_c1 VALUES (3,'Joe'),(1,'Jack'),(2,'Scott'); --查看。 gaussdb=# SELECT * FROM test_c1; id | name ----+------- 3 | Joe 1 | Jack 2 | Scott (3 rows) --聚簇排序。 gaussdb=# CLUSTER test_c1 USING idx_test_c1_id; --查看。 gaussdb=# SELECT * FROM test_c1; id | name ----+------- 1 | Jack 2 | Scott 3 | Joe (3 rows) --删除。 gaussdb=# DROP TABLE test_c1; 对已做过聚簇的表重新进行聚簇排序： --建表。 gaussdb=# CREATE TABLE test(col1 int,CONSTRAINT pk_test PRIMARY KEY (col1)); --第一次聚簇排序不带USING关键字报错。 gaussdb=# CLUSTER test; ERROR: there is no previously clustered index for table "test" --聚簇排序。 gaussdb=# CLUSTER test USING pk_test; --插入数据。 gaussdb=# INSERT INTO test VALUES (1),(99),(10),(8); --对已做过聚簇的表重新进行聚簇。 gaussdb=# CLUSTER VERBOSE test; INFO: clustering "public.test" using index scan on "pk_test"(dn_6001 pid=3672) INFO: "test": found 0 removable, 4 nonremovable row versions in 1 pages(dn_6001 pid=3672) DETAIL: 0 dead row versions cannot be removed yet. CPU 0.00s/0.00u sec elapsed 0.01 sec. CLUSTER --删除。 gaussdb=# DROP TABLE test; 对分区进行聚簇排序： --建表并向表中插入数据。 gaussdb=# CREATE TABLE test_c2(id int, info varchar(4)) PARTITION BY RANGE (id)( PARTITION p1 VALUES LESS THAN (11), PARTITION p2 VALUES LESS THAN (21) ); gaussdb=# CREATE INDEX idx_test_c2_id1 ON test_c2(id); gaussdb=# INSERT INTO test_c2 VALUES (6,'ABBB'),(2,'ABAB'),(9,'AAAA'); gaussdb=# INSERT INTO test_c2 VALUES (11,'AAAB'),(19,'BBBA'),(16,'BABA'); --查看。 gaussdb=# SELECT * FROM test_c2; id | info ----+------ 6 | ABBB 2 | ABAB 9 | AAAA 11 | AAAB 19 | BBBA 16 | BABA (6 rows) --对分区p2进行聚簇排序。 gaussdb=# CLUSTER test_c2 PARTITION (p2) USING idx_test_c2_id1; --查看。 gaussdb=# SELECT * FROM test_c2; id | info ----+------ 6 | ABBB 2 | ABAB 9 | AAAA 11 | AAAB 16 | BABA 19 | BBBA (6 rows) --删除。 gaussdb=# DROP TABLE test_c2;

语法格式 对一个表进行聚簇排序。 CLUSTER [ VERBOSE ] table_name [ USING index_name ]; 对一个分区进行聚簇排序。 CLUSTER [ VERBOSE ] table_name PARTITION ( partition_name ) [ USING index_name ]; 对已做过聚簇的表重新进行聚簇。 CLUSTER [ VERBOSE ];

注意事项 只有行存B-tree索引支持CLUSTER操作。 如果用户只是随机访问表中的行，那么表中数据的实际存储顺序是无关紧要的。但是，如果对某些特定数据的访问次数较多，而且有一个索引将这些数据分组，那么使用CLUSTER索引对性能会有所提升。 如果一个请求从表中查找的索引是一个范围，或者是一个索引值对应多行，CLUSTER也会有助于应用，因为如果索引标识出了第一匹配行所在的存储页，所有其它行也可能也已经在同一个存储页里了，这样便节省了磁盘访问的时间，加速了查询。 在聚簇过程中，系统会先创建一个按照索引顺序建立的表的临时备份，同时也建立表上的每个索引的临时备份。因此，聚簇过程中需要保证磁盘上有足够的剩余空间，至少是表大小与全部索引大小之和。 因为CLUSTER记录着哪些索引曾被用于聚簇，所以用户可以在第一次手动指定索引，对指定表进行聚簇，然后设置一个周期化执行的维护脚本，只需执行不带参数的CLUSTER命令，就可以实现对想要周期性聚簇的表进行自动更新。 因为优化器记录着有关表的排序的统计，在表上执行聚簇操作后，需运行ANALYZE操作以确保优化器具备最新的排序信息，否则，优化器可能会选择非最优的查询规划。 CLUSTER不允许在事务中执行。 如果没有将GUC参数xc_maintenance_mode设置为on，那么CLUSTER操作将跳过所有系统表。

quote_all_identifiers 参数说明：当数据库生成SQL时，此选项强制引用所有的标识符（包括非关键字）。这将影响到EXPLAIN的输出及函数的结果，例如pg_get_viewdef。详细说明请参见gs_dump的--quote-all-identifiers选项。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 on表示打开强制引用。 off表示关闭强制引用。 默认值：off