华为云用户手册

功能描述 为当前事务做两阶段提交的准备。 在命令之后，事务就不再和当前会话关联了；它的状态完全保存在磁盘上，它被提交成功的可能性非常高，即使是在请求提交之前数据库发生了崩溃也如此。 一旦准备好了，一个事务就可以在稍后用COMMIT PREPARED或 ROLLBACK PREPARED命令分别进行提交或者回滚。这些命令可以从任何会话中发出，而不光是最初执行事务的会话。 从发出命令的会话的角度来看，PREPARE TRANSACTION不同于ROLLBACK：在执行它之后，就不再有活跃的当前事务了，并且预备事务的效果无法见到 (在事务提交的时候其效果会再次可见)。 如果PREPARE TRANSACTION因为某些原因失败，那么它就会变成一个ROLLBACK，当前事务被取消。

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

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中对应设置方法进行设置。 设置建议：推荐使用默认值。

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_PROCS - 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共享内存或者信号量，可能超过操作系统缺省配置的最大值。这种情况下，请酌情对数值加以调整。 设置不当的风险与影响：无

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

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

local_bind_address 参数说明：声明当前节点连接数据库其他节点绑定的本地IP地址。 参数类型：字符串 参数单位：无 取值范围：IPv4格式地址，不支持多IP设置。 默认值：数据库实例安装好后，根据public_cloud.conf配置文件中不同实例的IP地址配置不同默认值。DN的默认参数值为：“data.net网卡对应的IP地址”。 public_cloud.conf文件保存的网卡信息，包括：mgr.net（管理网卡）、data.net（数据网卡）、virtual.net（虚拟网卡） 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：无

注意事项 只有表空间所有者或者被授予了表空间DROP权限的用户有权限执行DROP TABLESPACE命令，系统管理员默认拥有此权限。 在删除一个表空间之前，表空间里面不能有任何数据库对象，否则会报错。 DROP TABLESPACE不支持回滚，因此，不能出现在事务块内部。 执行DROP TABLESPACE操作时，如果有另外的会话执行\db查询操作，可能会由于TABLESPACE事务的原因导致查询失败，请重新执行\db查询操作。 如果执行DROP TABLESPACE失败，需要再次执行一次DROP TABLESPACE IF EXISTS。

hotkey特性函数 gs_stat_get_hotkeys_info() 描述：获取本地节点查询的热词信息。 返回值类型：Tuple 示例： 1 2 3 4 5 6 gaussdb=# SELECT * FROM gs_stat_get_hotkeys_info() order by count, hash_value; database_name | schema_name | table_name | key_value | hash_value | count ---------------+-------------+-------------------+-----------+------------+------- regression | public | hotkey_single_col | {22} | 1858004829 | 2 regression | public | hotkey_single_col | {11} | 2011968649 | 2 (2 rows) gs_stat_clean_hotkeys() 描述：清理hotkey缓存，重置hotkey状态信息。 返回值类型：bool，恒为true 示例： 1 2 3 4 5 gaussdb=# SELECT * FROM gs_stat_clean_hotkeys(); gs_stat_clean_hotkeys ----------------------- t (1 row) 父主题： 函数和操作符

PV_SESSION_STAT PV_SESSION_STAT视图显示以会话线程或AutoVacuum线程为单位的统计会话状态信息。具体字段信息如表1所示。 表1 PV_SESSION_STAT字段 名称 类型 描述 sessid text 线程标识+线程启动时间。 statid integer 统计编号。 statname text 统计会话名称。 statunit text 统计会话单位。 value bigint 统计会话值。 父主题： 其他系统视图

示例 --创建表customer_demographics_t1。 gaussdb=# CREATE TABLE customer_demographics_t1 ( CD_DEMO_SK INTEGER NOT NULL, CD_GENDER CHAR(1) , CD_MARITAL_STATUS CHAR(1) , CD_EDUCATION_STATUS CHAR(20) , CD_PURCHASE_ESTIMATE INTEGER , CD_CREDIT_RATING CHAR(10) , CD_DEP_COUNT INTEGER , CD_DEP_EMPLOYED_COUNT INTEGER , CD_DEP_COLLEGE_COUNT INTEGER ) ; --插入记录。 gaussdb=# INSERT INTO customer_demographics_t1 VALUES(1920801,'M', 'U', 'DOCTOR DEGREE', 200, 'GOOD', 1, 0,0); --开启事务。 gaussdb=# START TRANSACTION; --更新字段值。把cd_education_status字段值更新为Unknown。 gaussdb=# UPDATE customer_demographics_t1 SET cd_education_status= 'Unknown'; --终止事务，上面所执行的更新会被撤销掉。 gaussdb=# ABORT; --查询数据。发现cd_education_status字段的值未被修改成Unknown。 gaussdb=# SELECT * FROM customer_demographics_t1 WHERE cd_demo_sk = 1920801; cd_demo_sk | cd_gender | cd_marital_status | cd_education_status | cd_purchase_estimate | cd_credit_rating | cd_dep_count | cd_dep_employed_count | cd_dep_college_count ------------+-----------+-------------------+----------------------+----------------------+------------------+--------------+-----------------------+---------------------- 1920801 | M | U | DOCTOR DEGREE | 200 | GOOD | 1 | 0 | 0 (1 row) --删除表。 gaussdb=# DROP TABLE customer_demographics_t1;

参数说明 SESSION 声明的参数只对当前会话起作用。如果SESSION和LOCAL都没出现，则SESSION为缺省值。 如果在事务中执行了此命令，命令的产生影响将在事务回滚之后消失。如果该事务已提交，影响将持续到会话的结束，除非被另外一个SET命令重置参数。 LOCAL 声明的参数只在当前事务中有效。在COMMIT或ROLLBACK之后，会话级别的设置将再次生效。 不论事务是否提交，此命令的影响只持续到当前事务结束。一个特例是：在一个事务里面，既有SET命令，又有SET LOCAL命令，且SET LOCAL在SET后面，则在事务结束之前，SET LOCAL命令会起作用，但事务提交之后，则是SET命令会生效。 TIME ZONE timezone 用于指定当前会话的本地时区。 取值范围：有效的本地时区。该选项对应的运行时参数名称为TimeZone，DEFAULT缺省值为PRC。 CURRENT_SCHEMA schema CURRENT_SCHEMA用于指定当前的模式。 取值范围：已存在模式名称。 SCHEMA schema 同CURRENT_SCHEMA。此处的schema是个字符串。 例如：set schema 'public'; NAMES {'charset_name' [COLLATE 'collation_name'] | DEFAULT}; 在sql_compatibility = 'MYSQL'模式下，并设置b_format_version='5.7'、b_format_dev_version='s2'时，支持指定COLLATE子句。 描述：用于设置客户端字符编码，常量字符串的字符集、字符序，及返回结果的字符集。 等价为： SET client_encoding = charset_name; SET character_set_connection = charset_name; SET collation_connection = collation_name; SET character_set_results = charset_name; 取值范围：MYSQL兼容模式下支持的字符集、字符序。暂不支持指定charset_name与数据库字符集不同。 其他场景下不支持指定COLLATE子句。 描述：用于设置客户端的字符编码。 等价为： SET client_encoding TO charset_name; 取值范围：有效的字符编码。默认编码为UTF8。 XML OPTION option 用于设置XML的解析方式。 取值范围：CONTENT（缺省）、DOCUMENT config_parameter 可设置的运行时参数的名称。可用的运行时参数可以使用SHOW ALL命令查看。 部分通过SHOW ALL查看的参数不能通过SET设置。如max_datanodes。 value config_parameter的新值。可以声明为字符串常量、标识符、数字，或者逗号分隔的列表。DEFAULT用于把这些参数设置为它们的缺省值。

语法格式 设置所处的时区。 1 SET [ SESSION | LOCAL ] TIME ZONE { timezone | LOCAL | DEFAULT }; 设置所属的模式。 1 2 3 SET [ SESSION | LOCAL ] {CURRENT_SCHEMA { TO | = } { schema | DEFAULT } | SCHEMA 'schema'}; 设置客户端编码集。 1 SET [ SESSION | LOCAL ] NAMES {'charset_name' [COLLATE 'collation_name'] | DEFAULT}; 设置XML的解析方式。 1 SET [ SESSION | LOCAL ] XML OPTION { DOCUMENT | CONTENT }; 设置其他运行时参数。 1 2 3 SET [ LOCAL | SESSION ] {config_parameter { { TO | = } { value | DEFAULT } | FROM CURRENT }};

ADM_ARGUMENTS ADM_ARGUMENTS视图显示所有存储过程或函数的参数信息。默认只有系统管理员权限才可以访问，普通用户需要授权才可以访问。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 ADM_ARGUMENTS字段 名称 类型 描述 owner character varying(128) 函数或存储过程的所有者。 object_name character varying(128) 函数或存储过程的名称。 package_name character varying(128) 包名。 object_id oid 函数或存储过程的OID。 overload character varying(40) 表示该函数是该名称的第n个重载函数。 subprogram_id numeric 包中函数或存储过程的位置。 argument_name character varying(128) 参数名称。 position numeric 该参数在参数列表中的位置，函数返回值的位置默认为0。 sequence numeric 定义参数的顺序，从1开始，返回类型在前，然后是每个参数。 data_level numeric 复合类型参数的嵌套深度，此列的值始终为0，因为每个参数现只显示一行。 data_type character varying(30) 参数的数据类型。 defaulted character varying(1) 参数是否有默认值： Y：表示有默认值。 N：表示没有默认值。 default_value text 暂不支持，值为NULL。 default_length numeric 暂不支持，值为NULL。 in_out character varying(9) 参数出入属性： IN：表示入参。 OUT：表示出参。 IN_OUT：表示出入参。 VARIADIC：表示VARIADIC参数。 data_length numeric 暂不支持，值为NULL。 data_precision numeric 暂不支持，值为NULL。 data_scale numeric 暂不支持，值为NULL。 radix numeric 数字的参数基数，smallint、integer、bigint、numeric、float为10，其余值为NULL。 character_set_name character varying(44) 暂不支持，值为NULL。 type_owner character varying(128) 数据类型所有者。 type_name character varying(128) 参数类型名，仅显示自定义类型。 type_subname character varying(128) 暂不支持，值为NULL。 type_link character varying(128) 暂不支持，值为NULL。 type_object_type character varying(7) 由type_owner、type_name和type_subname列描述的类型的类型： TABLE：表示参数为表类型。 VIEW：表示参数为视图类型。 其余值为NULL。 pls_type character varying(128) 对于数字类型参数，为参数的PL/SQL类型的名称，否则为空。 char_length numeric 暂不支持，值为NULL。 char_used character varying(1) 暂不支持，varchar，nvarchar2，bpchar，char类型值为B，其余值为NULL。 origin_con_id character varying(256) 暂不支持，值为0。 父主题： 其他系统视图

V$GLOBAL_TRANSACTION V$GLOBAL_TRANSACTION视图显示有关当前活动全局事务的信息。默认只有系统管理员权限才可以访问此系统视图，普通用户若要访问需要得到授权。该视图同时存在于PG_CATALOG和SYS Schema下。具体字段信息如表1所示。 表1 V$GLOBAL_TRANSACTION字段 名称 类型 描述 formatid numeric 全局事务格式标识符。暂不支持，值为NULL。 globalid raw 全局事务标识符。 branchid raw 全局事务分支标识符。暂不支持，值为NULL。全局事务的每一个单独事务称为分支。 branches numeric 全局事务分支总数。 refcount numeric 全局事务的同级数（必须与分支相同）。 preparecount numeric 已准备的全局事务分支数。当system_view_version参数大于0时，不存在已准备的全局事务分支时为0，否则为NULL。 state character varying(38) 全局事务的分支的状态。 flags numeric 状态的数字表示形式。 coupling character varying(15) 表示分支是自由(`FREE`)、松散耦合(`LOOSELY COUPLED`)、还是紧密耦合(TIGHTLY COUPLED)。暂不支持，值为NULL。 con_id numeric 与数据相关的容器的id。暂不支持，值为0。 父主题： 其他系统视图

PG_AUTHID PG_AUTHID系统表存储有关数据库认证标识符（角色）的信息。角色把“用户”的概念包含在内。一个用户实际上就是一个rolcanlogin标志被设置的角色。任何角色（不管rolcanlogin设置与否）都能够把其他角色作为成员。 GaussDB中只有一份pg_authid，不是每个数据库有一份。需要有系统管理员权限才可以访问此系统表。 表1 PG_AUTHID字段 名称 类型 描述 oid oid 行标识符（隐含属性，必须明确选择）。 rolname name 角色名称。 rolsuper boolean 角色是否是拥有最高权限的初始系统管理员。 t（true）：表示是。 f（false）：表示不是。 rolinherit boolean 角色是否自动继承其所属角色的权限。 t（true）：表示自动继承。 f（false）：表示不自动继承。 rolcreaterole boolean 角色是否可以创建更多角色。 t（true）：表示可以。 f（false）：表示不可以。 rolcreatedb boolean 角色是否可以创建数据库。 t（true）：表示可以。 f（false）：表示不可以。 rolcatupdate boolean 角色是否可以直接更新系统表。只有usesysid=10的初始系统管理员拥有此权限。其他用户无法获得此权限。 t（true）：表示可以。 f（false）：表示不可以。 rolcanlogin boolean 角色是否可以登录，也就是说，这个角色可以给予会话认证标识符。 t（true）：表示可以。 f（false）：表示不可以。 rolreplication boolean 角色是否具有复制权限。 t（true）：表示有。 f（false）：表示没有。 rolauditadmin boolean 角色是否具有审计管理员权限。 t（true）：表示有。 f（false）：表示没有。 rolsystemadmin boolean 角色是否具有系统管理员权限。 t（true）：表示有。 f（false）：表示没有。 rolconnlimit integer 对于可以登录的角色，限制其最大并发连接数量。 -1 表示没有限制。 rolpassword text 密码密文，如果没有密码，则为NULL。 rolvalidbegin timestamp with time zone 账户的有效开始时间，如果没有开始时间，则为NULL。 rolvaliduntil timestamp with time zone 账户的有效结束时间，如果没有结束时间，则为NULL。 rolrespool name 用户所能够使用的resource pool。 roluseft boolean 角色是否可以操作外表。 t（true）：表示可以。 f（false）：表示不可以。 rolparentid oid 用户所在组用户的OID。 roltabspace text 用户数据表的最大空间限额。 rolkind "char" 特殊用户种类。 n：表示普通用户。 p：表示永久用户。 rolnodegroup oid 该字段不支持。 roltempspace text 用户临时表的最大空间限额，单位为KB。 rolspillspace text 用户执行作业时下盘数据的最大空间限额，单位为KB。 rolexcpdata text 用户可以设置的查询规则（当前未使用）。 rolmonitoradmin boolean 角色是否具有监控管理员权限。 t（true）：表示有。 f（false）：表示没有。 roloperatoradmin boolean 角色是否具有运维管理员权限。 t（true）：表示有。 f（false）：表示没有。 rolpolicyadmin boolean 角色是否具有安全策略管理员权限。 t（true）：表示有。 f（false）：表示没有。 父主题： 连接和认证

GLOBAL_FILE_IOSTAT 显示数据库内所有节点的数据文件I/O统计信息，如表1所示。 表1 GLOBAL_FILE_IOSTAT字段 名称 类型 描述 node_name name 节点名称。 filenum oid 文件标识。 dbid oid 数据库标识。 spcid oid 表空间标识。 phyrds bigint 读物理文件的数目。 phywrts bigint 写物理文件的数目。 phyblkrd bigint 读物理文件块的数目。 phyblkwrt bigint 写物理文件块的数目。 readtim bigint 读文件的总时长（单位：微秒）。 writetim bigint 写文件的总时长（单位：微秒）。 avgiotim bigint 读写文件的平均时长（单位：微秒）。 lstiotim bigint 最后一次读文件时长（单位：微秒）。 miniotim bigint 读写文件的最小时长（单位：微秒）。 maxiowtm bigint 读写文件的最大时长（单位：微秒）。 父主题： File

GLOBAL_OS_THREADS 提供整个集群中所有正常节点下的线程状态信息，如表1所示。 表1 GLOBAL_OS_THREADS字段 名称 类型 描述 node_name text 当前节点的名称。 pid bigint 当前节点进程中正在运行的线程号。 lwpid integer 与pid对应的轻量级线程号。 thread_name text 与pid对应的线程名称。 creation_time timestamp with time zone 与pid对应的线程创建的时间。 父主题： OS

如何查看某张表创建时间？ 答：在系统视图PG_TABLES里created字段的取值为表的真实创建时间。 --创建表。 gaussdb=# CREATE TABLE test(id int, name varchar(10)); --查询test表创建时间。 gaussdb=# SELECT tablename,created FROM pg_tables WHERE tablename = 'test'; tablename | created -----------+------------------------------- test | 2024-01-12 14:50:59.611988+08 (1 row) 父主题： FAQ

SPM计划管理函数 当前SPM计划管理特性在分布式下不支持，所以在分布式下调用下面的这些函数都会给出分布式下不支持的错误提示。 GS_SPM_EVOLUTE_PLAN(sql_hash, plan_hash) 描述：GS_SPM_EVOLUTE_PLAN属于DBE_SQL_UTIL schema，是SPM特性用于计划演进的接口函数。 参数：参数介绍见表1 表1 GS_SPM_EVOLUTE_PLAN入参和返回值列表 参数 类型 描述 取值范围 sql_hash IN bigint SQL文本的hash值。 - plan_hash IN bigint SQL计划outline文本的hash值。 - evolute_status OUT boolean 演进行为是否正常完成：t表示正常；异常会报错。 t/f 返回值类型：boolean GS_SPM_SET_PLAN_STATUS(sql_hash, plan_hash, plan_status) 描述：GS_SPM_SET_PLAN_STATUS属于DBE_SQL_UTIL schema，它是SPM特性用于修改baseline状态的接口函数。 参数：参数介绍见表2 表2 GS_SPM_SET_PLAN_STATUS入参和返回值列表 参数 类型 描述 取值范围 sql_hash IN bigint SQL文本的hash值。 - plan_hash IN bigint SQL计划outline文本的hash值。 - plan_status IN text 计划的状态。 ACC：表示已经接受的计划。 UNACC：表示未接受的计划。 FIXED：一种特殊的ACC状态的计划，计划的匹配优先级高于ACC状态的计划。 execute_status OUT boolean 修改计划状态行为是否正常完成：t表示正常；异常会报错。 t/f 返回值类型：boolean GS_SPM_DISPLAY_PLANS(sql_hash) 描述：GS_SPM_DISPLAY_PLANS属于DBE_SQL_UTIL schema，它是SPM特性用于查看单条SQL所有baseline的接口函数。 参数：参数介绍见表3 表3 GS_SPM_DISPLAY_PLANS入参和返回值列表 参数 类型 描述 取值范围 sql_hash IN bigint SQL唯一标识。 - sql_hash OUT bigint SQL文本的hash值。 - plan_hash OUT bigint SQL计划outline文本的hash值。 - outline OUT text 当前计划对应outline的所有Hint的组合字符串。 - cost OUT double 当前计划的代价。 - status OUT text 当前计划的状态。 ACC：表示已经接受的计划。 UNACC：表示未接受的计划。 FIXED：一种特殊的ACC状态的计划，计划的匹配优先级高于ACC状态的计划。 gplan OUT boolean 当前计划是否是gplan。t表示是gplan；异常会报错。 t/f 返回值类型：bigint, text, double, text, boolean GS_SPM_RELOAD_PLAN(sql_hash，plan_hash) 描述：GS_SPM_RELOAD_PLAN属于DBE_SQL_UTIL schema，它是SPM特性用于加载baseline系统表中某baseline到SPM global cache中的接口函数。 参数：参数介绍见表4 表4 GS_SPM_RELOAD_PLAN入参和返回值列表 参数 类型 描述 取值范围 sql_hash IN bigint SQL文本的hash值。 - plan_hash IN bigint SQL计划outline文本的hash值。 - execute_status OUT boolean baseine的加载行为是否正常完成：t表示正常；异常会报错。 t/f 返回值类型：boolean GS_SPM_VALIDATE_PLAN(sql_hash, plan_hash) 描述：GS_SPM_VALIDATE_PLAN属于DBE_SQL_UTIL schema，它是SPM特性用于计划可用性验证的接口函数。 参数：参数介绍见表5 表5 GS_SPM_VALIDATE_PLAN入参和返回值列表 参数 类型 描 取值范围 sql_hash IN bigint SQL文本的hash值。 - plan_hash IN bigint SQL计划outline文本的hash值。 - execute_status OUT boolean 被验证的计划是否可用： t：被验证的计划可用；f: 被验证的计划不可用 t/f 返回值类型：boolean GS_SPM_DELETE_PLAN(sql_hash, plan_hash) 描述：GS_SPM_DELETE_PLAN属于DBE_SQL_UTIL schema，它是SPM特性用于计划删除baseline的接口函数。 参数： 参数介绍见表6 表6 GS_SPM_DELETE_PLAN入参和返回值列表 参数 类型 描述 取值范围 sql_hash IN bigint SQL文本的hash值。 - plan_hash IN bigint SQL计划outline文本的hash值。 - execute_status OUT boolean 计划删除行为是否正常完成：t表示正常；异常会报错。 t/f 返回值类型：boolean 父主题： 函数和操作符

GS_ADM_ILMTASKS GS_ADM_ILMTASKS视图反映ADO Task的概要信息，包含Task ID，Task Owner，状态以及时间信息。默认只有系统管理员权限才可以访问此系统视图，普通用户需要授权才可以访问。 表1 GS_ADM_ILMTASKS字段 名称 类型 描述 task_id bigint ADO Task的ID。 task_owner character varying(128) ADO Task发起的用户，仅ADM视图存在此列 state character varying(9) 状态： INACTIVE：非活动 ACTIVE：活动 COMPLETED：完成 UNKNOWN: 评估中 creation_time timestamp with time zone 创建时间。 start_time timestamp with time zone 变成活动状态的时间。 completion_time timestamp with time zone 完成时间。 父主题： OLTP表压缩

DB_IND_SUBPARTITIONS DB_IND_SUBPARTITIONS视图显示当前用户所能访问的二级分区表Local索引的索引分区信息（不包含分区表全局索引）。所有用户都可以访问。该视图同时存在于PG_CATALOG和SYS Schema下。分布式暂不支持二级分区，该表字段目前全置NULL。。 表1 DB_IND_SUBPARTITIONS字段 名称 类型 描述 index_owner character varying(128) 暂不支持，值为NULL。 index_name character varying(128) 暂不支持，值为NULL。 partition_name character varying(128) 暂不支持，值为NULL。 subpartition_name character varying(128) 暂不支持，值为NULL。 high_value text 暂不支持，值为NULL。 high_value_length numeric 暂不支持，值为NULL。 partition_position numeric 暂不支持，值为NULL。 subpartition_position numeric 暂不支持，值为NULL。 status character varying(8) 暂不支持，值为NULL。 tablespace_name character varying(30) 暂不支持，值为NULL。 pct_free numeric 暂不支持，值为NULL。 ini_trans numeric 暂不支持，值为NULL。 max_trans numeric 暂不支持，值为NULL。 initial_extent numeric 暂不支持，值为NULL。 next_extent numeric 暂不支持，值为NULL。 min_extent numeric 暂不支持，值为NULL。 max_extent numeric 暂不支持，值为NULL。 max_size numeric 暂不支持，值为NULL。 pct_increase numeric 暂不支持，值为NULL。 freelists numeric 暂不支持，值为NULL。 freelist_groups numeric 暂不支持，值为NULL。 logging character varying(7) 暂不支持，值为NULL。 compression character varying(13) 暂不支持，值为NULL。 blevel numeric 暂不支持，值为NULL。 leaf_blocks numeric 暂不支持，值为NULL。 distinct_keys numeric 暂不支持，值为NULL。 avg_leaf_blocks_per_key numeric 暂不支持，值为NULL。 avg_data_blocks_per_key numeric 暂不支持，值为NULL。 clustering_factor numeric 暂不支持，值为NULL。 num_rows numeric 暂不支持，值为NULL。 sample_size numeric 暂不支持，值为NULL。 last_analyzed date 暂不支持，值为NULL。 buffer_pool character varying(7) 暂不支持，值为NULL。 flash_cache character varying(7) 暂不支持，值为NULL。 cell_flash_cache character varying(7) 暂不支持，值为NULL。 user_stats character varying(3) 暂不支持，值为NULL。 global_stats character varying(3) 暂不支持，值为NULL。 interval character varying(3) 暂不支持，值为NULL。 segment_created character varying(3) 暂不支持，值为NULL。 domidx_opstatus character varying(6) 暂不支持，值为NULL。 parameters character varying(1000) 暂不支持，值为NULL。 父主题： 分区表

GLOBAL_OPERATOR_RUNTIME GLOBAL_OPERATOR_RUNTIME视图显示当前用户在所有CN节点上正在执行的作业的算子相关信息，如表1所示。 表1 GLOBAL_OPERATOR_RUNTIME的字段 名称 类型 描述 queryid bigint 语句执行使用的内部query_id。 pid bigint 后端线程id。 plan_node_id integer 查询对应的执行计划的plan node id。 plan_node_name text 对应于plan_node_id的算子的名称。 start_time timestamp with time zone 该算子处理第一条数据的开始时间。 duration bigint 该算子到结束时候总的执行时间（ms）。 status text 当前算子的执行状态，包括finished和running。 query_dop integer 当前算子执行时的并行度。 estimated_rows bigint 优化器估算的行数信息。 tuple_processed bigint 当前算子返回的元素个数。 min_peak_memory integer 当前算子在所有DN上的最小内存峰值（MB）。 max_peak_memory integer 当前算子在所有DN上的最大内存峰值（MB）。 average_peak_memory integer 当前算子在所有DN上的平均内存峰值（MB）。 memory_skew_percent integer 当前算子在各DN间的内存使用倾斜率。 min_spill_size integer 若发生下盘，所有DN上下盘的最小数据量（MB），默认为0。 max_spill_size integer 若发生下盘，所有DN上下盘的最大数据量（MB），默认为0。 average_spill_size integer 若发生下盘，所有DN上下盘的平均数据量（MB），默认为0。 spill_skew_percent integer 若发生下盘，DN间下盘倾斜率。 min_cpu_time bigint 该算子在所有DN上的最小执行时间（ms）。 max_cpu_time bigint 该算子在所有DN上的最大执行时间（ms）。 total_cpu_time bigint 该算子在所有DN上的总执行时间（ms）。 cpu_skew_percent integer DN间执行时间的倾斜率。 warning text 主要显示如下几类告警信息： Sort/SetOp/HashAgg/HashJoin spill Spill file size large than 256MB Broadcast size large than 100MB Early spill Spill times is greater than 3 Spill on memory adaptive Hash table conflict 父主题： Operator

Psycopg接口参考 Psycopg接口是一套提供给用户的API方法，本节将对部分常用接口做具体描述。 psycopg2.connect() connection.cursor() cursor.execute(query,vars_list) cursor.executemany(query,vars_list) connection.commit() connection.rollback() cursor.fetchone() cursor.fetchall() cursor.close() connection.close() 父主题： 基于Psycopg开发

SHARED_MEMORY_DETAIL 查询当前节点所有已产生的共享内存上下文的使用信息，如表1所示。 表1 SHARED_MEMORY_DETAIL字段 名称 类型 描述 contextname text 内存上下文的名称。 level smallint 内存上下文的级别。 parent text 上级内存上下文。 totalsize bigint 共享内存总大小（单位：字节）。 freesize bigint 共享内存剩余大小（单位：字节）。 usedsize bigint 共享内存使用大小（单位：字节）。 父主题： Memory

事务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表示的状态是未知的（运行、准备、冻结等）。 返回类型：Boolean pgxc_is_committed(transaction_id, bucketid) 描述: 当前版本集中式不支持hashbucket 表，该接口函数调用报错。 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, text get_remote_prepared_xacts() 描述：获取所有远程节点两阶段残留事务信息，包括事务id、两阶段gid名称、prepared的时间、owner的名称、database的名称及node_name。 返回类型：xid, text, timestamptz, name, text global_clean_prepared_xacts(text, text) 描述：并发清理两阶段残留事务，仅GaussDB分布式场景下gs_clean工具可以调用清理，其他用户调用均返回false。 返回类型：Boolean gs_get_next_xid_csn() 描述：返回全局所有节点上的next_xid和next_csn值。 返回值：如表13所示。 表13 gs_get_next_xid_csn返回参数说明 字段名 描述 nodename 节点名称。 next_xid 当前节点下一个事务id号。 next_csn 当前节点下一个csn号。