华为云用户手册

GS_SEG_EXTENTS GS_SEG_EXTENTS查看所有表空间的扩展信息。该视图输出用户段对象的所有扩展，包含1号文件中的segment head、fork head、level1 page，2~5号文件中的data extent。只支持管理员权限用户查询。 表1 GS_SEG_EXTENTS字段 名称 类型 描述 node_name text 节点名称。 tablespace_name name 段对象所属的表空间。 bucketnode integer 0~1023表示hashbucket表的bucketnode。 1024表示段页式普通表的bucketnode。 1025表示段页式全局临时表的bucketnode。 1026表示段页式unlogged表的bucketnode。 1027表示段页式本地临时表的bucketnode。 head_block_id bigint 段头页面号。 extent_id integer 逻辑扩展号。 file_id integer 扩展所在的数据文件标识。取值范围：[1,5]的int4值。 forknum integer 段对象的分支类型。取值范围： 0表示main fork。 1表示fsm fork。 2表示vm fork。 block_id bigint 扩展所在的数据文件中的起始页面号。 blocks integer 扩展大小。取值范围：1、8、128、1024、4096。 usage_type text 扩展的使用类型。取值范围： segment head表示段头。 fork head表示分支头。 level1 page表示level页面。 data extent表示数据扩展。 父主题： 段页式存储

FILE_IOSTAT 通过对数据文件I/O的统计，反映数据的I/O性能，用以发现I/O操作异常等性能问题，如表1所示。多租场景下，non-PDB访问该视图时返回全部信息，PDB访问该视图时仅返回该PDB相关信息。在PDB中通过该视图查询到的I/O统计信息是未持久化的，数据库重启后清零。 表1 FILE_IOSTAT字段 名称 类型 描述 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

GS_DB_LINKS GS_DB_LINKS系统视图显示DATABASE LINK对象的相关信息，用户可以查看属于自己和PUBLIC级别的DATABASE LINK信息。 表1 GS_DB_LINKS字段 名称 类型 描述 dblinkid oid 当前DATABASE LINK对象的OID。 dlname name 当前DATABASE LINK对象的名称。 dlowner oid 当前DATABASE LINK对象拥有者的ID。对象拥有者为public时值为0。 dlownername name 当前DATABASE LINK对象拥有者的名称。 options text[] 当前DATABASE LINK对象的连接信息，使用“keyword=value”格式的字符串。 useroptions text 当前DATABASE LINK对象连接的远端用户信息。 heterogeneous text 暂不支持，值为NULL。 protocol text 暂不支持，值为NULL。 opencursors text 暂不支持，值为NULL。 intransaction boolean 当前DATABASE LINK对象是否在事务中。 updatasent boolean 当前DATABASE LINK对象是否使用了更新数据的语句。 父主题： DATABASE LINK

GS_COLUMN_KEYS_ARGS GS_COLUMN_KEYS_ARGS系统表记录密态等值特性中，客户端加密主密钥相关元数据信息，每条记录对应客户端加密主密钥的一个键值对信息。 表1 GS_COLUMN_KEYS_ARGS字段 名称 类型 描述 oid oid 行标识符（隐含字段）。 column_key_id oid 列加密密钥（cek）oid。 function_name name 值为encryption。 key name 列加密密钥（cek）的元数据信息对应的名称。 value bytea 列加密密钥（cek）的元数据信息名称的值。 父主题： 密态等值查询

SUMMARY_STAT_SYS_TABLES 显示数据库各节点pg_catalog、information_schema以及pg_toast模式下所有系统表的状态信息的汇总求和结果（对每个节点下系统表的状态信息汇总求和，其中timestamp类型字段不进行求和，仅取所有节点该字段的最新值），如表1所示。 表1 SUMMARY_STAT_SYS_TABLES字段 名称 类型 描述 schemaname name 此表所在的Schema名。 relname name 表名。 seq_scan numeric 此表发起的顺序扫描数。 seq_tup_read numeric 顺序扫描抓取的活跃行数。 idx_scan numeric 此表发起的索引扫描数。 idx_tup_fetch numeric 索引扫描抓取的活跃行数。 n_tup_ins numeric 插入行数。 n_tup_upd numeric 更新行数。 n_tup_del numeric 删除行数。 n_tup_hot_upd numeric HOT更新行数（即没有更新索引列的行数）。 n_live_tup numeric 估计活跃行数。 n_dead_tup numeric 估计不活跃行数。在Ustore表中仅代表不活跃行指针数量。 last_vacuum timestamp with time zone 最后一次此表是手动清理的（不计算VACUUM FULL）时间。 last_autovacuum timestamp with time zone 上次被autovacuum守护线程清理的时间。 last_analyze timestamp with time zone 上次手动分析这个表的时间。 last_autoanalyze timestamp with time zone 上次被autovacuum守护线程分析的时间。 vacuum_count numeric 这个表被手动清理的次数（不计算VACUUM FULL）。 autovacuum_count numeric 这个表被autovacuum清理的次数。 analyze_count numeric 这个表被手动分析的次数。 autoanalyze_count numeric 这个表被autovacuum守护线程分析的次数。 父主题： Object

返回值 PQresultStatus：命令执行结果的枚举，包括： 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 PQresultStatus可以返回下面数值之一： PGRES_EMPTY_QUERY 发送给服务器的字串是空的。 PGRES_COMMAND_OK 成功完成一个不返回数据的命令。 PGRES_TUPLES_OK 成功执行一个返回数据的查询（比如SELECT或者SHOW）。 PGRES_COPY_OUT （从服务器）Copy Out （复制出）数据传输开始。 PGRES_COPY_IN Copy In（复制入）（到服务器）数据传输开始。 PGRES_BAD_RESPONSE 服务器的响应无法理解。 PGRES_NONFATAL_ERROR 发生了一个非致命错误（通知或者警告）。 PGRES_FATAL_ERROR 发生了一个致命错误。 PGRES_COPY_BOTH 复制入/出（到和从服务器）数据传输开始。这个特性当前只用于流复制， 所以这个状态不会在普通应用中发生。 PGRES_SINGLE_TUPLE PGresult包含一个来自当前命令的结果元组。 这个状态只在查询选择了单行模式时发生。

DB_TAB_PARTITIONS DB_TAB_PARTITIONS视图显示当前用户所能访问的一级分区信息（包括二级分区表）。所有用户都可以访问。该视图同时存在于PG_CATA LOG 和SYS Schema下。 表1 DB_TAB_PARTITIONS字段 名称 类型 描述 table_owner character varying(64) 表的所有者。 table_name character varying(64) 关系表名称。 partition_name character varying(64) 分区名称。 high_value text 分区的边界值。 对于范围分区和间隔分区，显示各分区的上边界值。 对于列表分区，显示各分区的取值列表。 对于哈希分区，显示各分区的编号。 tablespace_name name 分区表的表空间名称。 schema character varying(64) 名称空间的名称。 subpartition_count bigint 二级分区的个数。 high_value_length integer 分区边界值表达式的长度。 composite character varying(3) 表是否为二级分区表。 partition_position numeric 分区在表中的位置。 pct_free numeric 块中可用空间的最小百分比。 pct_used numeric 暂不支持，值为NULL。 ini_trans numeric 初始事务数，默认值为4，非USTORE分区表时为NULL。 max_trans numeric 最大事务数，默认值为128，非USTORE分区表时为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) 是否记录对表的更改。 compression character varying(8) 表分区的实际压缩属性。 compress_for character varying(30) 暂不支持，值为NULL。 num_rows numeric 分区中的行数。 blocks numeric 暂不支持，值为NULL。 empty_blocks numeric 暂不支持，值为NULL。 avg_space numeric 暂不支持，值为NULL。 chain_cnt numeric 暂不支持，值为NULL。 avg_row_len numeric 暂不支持，值为NULL。 sample_size numeric 暂不支持，值为NULL。 last_analyzed timestamp with time zone 最近分析此分区的日期。 buffer_pool character varying(7) 用于分区块的缓冲池。 flash_cache character varying(7) 暂不支持，值为NULL。 cell_flash_cache character varying(7) 暂不支持，值为NULL。 global_stats character varying(3) 暂不支持，值为NULL。 user_stats character varying(3) 暂不支持，值为NULL。 is_nested character varying(3) 这是否是嵌套表分区。 parent_table_partition character varying(128) 暂不支持，值为NULL。 interval character varying(3) 分区是否在间隔分区表的间隔节中。 segment_created character varying(4) 表分区是否创建了段。 indexing character varying(4) 暂不支持，值为NULL。 read_only character varying(4) 暂不支持，值为NULL。 inmemory character varying(8) 暂不支持，值为NULL。 inmemory_priority character varying(8) 暂不支持，值为NULL。 inmemory_distribute character varying(15) 暂不支持，值为NULL。 inmemory_compression character varying(17) 暂不支持，值为NULL。 inmemory_duplicate character varying(13) 暂不支持，值为NULL。 cellmemory character varying(24) 暂不支持，值为NULL。 inmemory_service character varying(12) 暂不支持，值为NULL。 inmemory_service_name character varying(100) 暂不支持，值为NULL。 memoptimize_read character varying(8) 暂不支持，值为NULL。 memoptimize_write character varying(8) 暂不支持，值为NULL。 父主题： 分区表

MY_JOBS MY_JOBS视图显示当前用户拥有的定时任务的详细信息。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 MY_JOBS字段 名称 类型 描述 job bigint 作业ID。 log_user name 创建者的UserName。 priv_user name 作业执行者的UserName。 dbname name 创建作业的数据库名称。 schema_user name 定时任务的默认模式名。 start_date timestamp without time zone 作业第一次开始执行的时间。 start_suc text 作业第一次成功执行对应的开始时间。 last_date timestamp without time zone 上次运行的开始时间。 last_suc text 上次成功运行的开始时间。 last_sec text 上次成功运行的开始时间，提供兼容性支持。 this_date timestamp without time zone 正在运行任务的开始时间。 this_suc text 正在运行任务的开始时间。 this_sec text 正在运行任务的开始时间，提供兼容性支持。 next_date timestamp without time zone 任务下次执行时间。 next_suc text 任务下次执行时间。 next_sec text 任务下次执行时间，提供兼容性支持。 total_time numeric 任务最近一次的执行时长。 broken text 如果status字段取值为'd'，则为'y'，否则为'n'。 status "char" 本步骤的执行状态，取值范围：（'r'、's'、'f'、'd'），默认为'r'，取值含义： r：运行中。 s：执行成功。 f：执行失败。 d：取消执行。 interval text 用来计算下次运行时间的时间表达式，如果为null则表示定时任务只执行一次。 failures smallint 失败计数，若作业连续执行失败16次，则不再继续执行。 what text 可执行的作业。 nls_env character varying(4000) 暂不支持，值为NULL。 misc_env raw 暂不支持，值为NULL。 instance numeric 暂不支持，值为NULL。 父主题： 其他系统视图

Go Go驱动是一个用于连接和操作 GaussDB数据库 的Go语言驱动。它提供了一些用于连接和操作 GaussDB 数据库的接口，可以用于执行查询、插入、更新和删除等操作。 以下是Go驱动当前支持的部分功能及其用法： 数据库连接：Go驱动支持通过db.Open连接数据库。连接串支持URL和DSN两种格式。 SQL执行与查询：Go驱动提供接口如db.Exec、db.Query等，可以用于SQL的执行与查询 。 事务管理：Go驱动支持Tx接口进行事务管理，其中实现了启动、提交、回滚事务等方法，确保数据库操作的一致性和完整性。 元数据访问： Go驱动提供ColumnType接口用于查询数据库中列属性信息，包括是否可以为空、数据库类型名称、长度和小数位数等信息。 可重用性：Go驱动提供Prepare方法用于预编译SQL，该SQL可以被多次执行，只需改变传入参数，提高数据库可重用性。 基于Go驱动开发详细教程请参见基于Go驱动开发。

JDBC JDBC（Java Database Connectivity，Java数据库连接）是用于执行SQL语句的Java API，可以为多种关系数据库提供统一访问接口。它允许Java应用程序通过SQL语句来执行数据库操作，包括查询、插入、更新和删除数据等。 以下是JDBC的一些关键特点和用法： 数据库连接管理：JDBC允许应用程序建立与数据库的连接，并管理这些连接的生命周期。 SQL执行： 使用JDBC，可以执行SQL查询、更新、删除等操作。这通过在Java代码中构建SQL语句并将其发送到数据库来实现。 事务管理：JDBC支持事务管理，可以通过JDBC API来启动、提交或回滚事务，确保数据库操作的一致性和完整性。 异常处理： JDBC定义了一组异常类来处理数据库操作期间可能发生的各种异常情况，开发人员可以使用try-catch块来捕获和处理这些异常。 批处理操作：JDBC提供了批处理功能，允许一次性执行多个SQL语句，从而提高数据库操作的效率。 元数据访问： 通过JDBC，可以获取数据库的元数据信息，如表结构、列名、数据类型等，从而动态地构建SQL查询或根据数据库结构进行操作。 总的来说，JDBC提供了一个灵活且强大的桥梁，使Java应用程序能够与各种不同的数据库进行交互，从而实现数据的持久化和管理。GaussDB库提供了对JDBC 4.2特性的支持，需要使用JDK1.8版本编译程序代码，不支持JDBC桥接ODBC方式。 基于JDBC开发详细教程请参见基于JDBC开发。

Psycopg Psycopg是一种用于执行SQL语句的PythonAPI，可以为GaussDB数据库提供统一访问接口，应用程序可基于它进行数据操作。Psycopg2是对libpq的封装，主要使用C语言实现，既高效又安全。它具有客户端游标和服务器端游标、异步通信和通知、支持“COPY TO/COPY FROM”功能。支持多种类型Python开箱即用，适配GaussDB数据类型。通过灵活的对象适配系统，可以扩展和定制适配。Psycopg2兼容Unicode。 GaussDB数据库提供了对Psycopg2特性的支持，并且支持psycopg2通过SSL模式连接。 基于Psycopg开发详细教程请参见基于Psycopg开发。 表2 Psycopg支持平台 操作系统 平台 Python版本 EulerOS V2.0SP5、Suse 12.5 ARM64位 x86_64位 3.8.5 EulerOS V2.0SP9 ARM64位 x86_64位 3.7.4 EulerOS V2.0SP10、Kylin v10、UnionTech20 ARM64位 x86_64位 3.7.9 EulerOS V2.0SP11 ARM64位 x86_64位 3.9.11 Huawei Cloud EulerOS 2.0 ARM64位 x86_64位 3.9.9 psycopg2在编译过程中，会链接（link）GaussDB的openssl，GaussDB的openssl与操作系统自带的openssl可能不兼容。如果遇到不兼容现象，例如提示"version 'OPENSSL_1_1_1f' not found"，请使用环境变量LD_LIBRARY_PATH进行隔离，以避免混用操作系统自带的openssl与GaussDB依赖的openssl。 例如，在执行某个调用psycopg2的应用软件client.py时，将环境变量显性赋予该应用软件： export LD_LIBRARY_PATH=/path/to/gaussdb/libs:$LD_LIBRARY_PATH python client.py 其中，/path/to/pyscopg2/lib 表示GaussDB依赖的openssl库所在目录，需根据文件实际存储路径修改。

ecpg ecpg（embedded SQL C preprocessor for GaussDB Kernel）是一种用于C语言程序的嵌入式SQL预处理器。一个嵌入式SQL程序由一种普通编程语言编写的代码（此处为C语言）和SQL命令共同组成。要构建该程序，源代码（*.pgc）首先通过嵌入式SQL预处理器，将源代码转换成一个普通C语言程序（*.c），然后再通过编译器处理。转换过的ecpg应用通过嵌入式SQL库（ecpglib）调用libpq库中的函数，与GaussDB Kernel服务器使用普通的前端/后端协议通信。 嵌入式SQL程序是插入了数据库相关动作的特殊代码的C语言程序。这种特殊代码形式通常如下： EXEC SQL ...; 这些语句在语法上取代了一个C语句，可以出现在全局或者是一个函数中。嵌入式SQL语句遵循普通SQL代码的大小写敏感规则，也允许嵌套的C语言代码风格注释（SQL标准的一部分）。不过，程序的C语言部分遵循C语言程序的标准，不支持嵌套注释。 基于ecpg开发详细教程请参见基于ecpg开发。

示例 char *stmt = "SELECT * FROM test1 WHERE a = ? AND b = ?"; EXEC SQL ALLOCATE DESCRIPTOR outdesc; EXEC SQL PREPARE foo FROM :stmt; EXEC SQL EXECUTE foo USING SQL DESCRIPTOR indesc INTO SQL DESCRIPTOR outdesc;

基本语句 在编写PL/SQL过程中，会定义一些变量，给变量赋值，调用其他存储过程等。介绍PL/SQL中的基本语句，包括定义变量、赋值语句、调用语句以及返回语句。 尽量不要在存储过程中调用包含密码的SQL语句，因为存储在数据库中的存储过程文本可能被其他有权限的用户看到导致密码信息泄漏。如果存储过程中包含其他敏感信息也需要配置存储过程的访问权限，以避免敏感信息泄漏。 定义变量 赋值语句 调用语句 父主题： 存储过程

GLOBAL_STATEMENT_COMPLEX_RUNTIME 显示当前用户在各个节点上正在执行的作业的负载管理记录，如表1所示。 表1 GLOBAL_STATEMENT_COMPLEX_RUNTIME的字段 名称 类型 描述 datid oid 连接后端的数据OID。 dbname name 连接后端的数据库名称。 schemaname text 模式的名称。 nodename text 节点名称。 username name 连接到后端的用户名。 application_name text 连接到后端的应用名。 client_addr inet 连接到后端的客户端的IP地址。如果此字段是null，它表明通过服务器机器上UNIX套接字连接客户端或者这是内部线程，如autovacuum。 client_hostname text 客户端的主机名，这个字段是通过client_addr的反向DNS查找得到。这个字段只有在启动log_hostname且使用IP连接时才非空。 client_port integer 客户端用于与后端通讯的TCP端口号，如果使用UNIX套接字，则为-1。 query_band text 用于标示作业类型，可通过GUC参数query_band进行设置，默认为空字符串。 pid bigint 后端线程ID。 block_time bigint 语句执行前的阻塞时间，单位ms。 start_time timestamp with time zone 语句执行的开始时间。 duration bigint 语句已经执行的时间，单位ms。 estimate_total_time bigint 语句执行预估总时间，单位ms。 estimate_left_time bigint 语句执行预估剩余时间，单位ms。 resource_pool name 用户使用的资源池。 control_group text 语句所使用的Cgroup。 estimate_memory integer 语句预估使用内存，单位MB。 min_peak_memory integer 语句在数据库节点上的最小内存峰值，单位MB。 max_peak_memory integer 语句在数据库节点上的最大内存峰值，单位MB。 average_peak_memory integer 语句执行过程中的内存使用平均值，单位MB。 memory_skew_percent integer 语句在数据库节点间的内存使用倾斜率。 spill_info text 语句在数据库节点上的下盘信息： None：数据库节点均未下盘。 All：数据库节点均下盘。 [a:b]：数量为b个数据库节点中有a个数据库节点下盘。 min_spill_size integer 若发生下盘，数据库节点上下盘的最小数据量，单位MB，默认为0。 max_spill_size integer 若发生下盘，数据库节点上下盘的最大数据量，单位MB，默认为0。 average_spill_size integer 若发生下盘，数据库节点上下盘的平均数据量，单位MB，默认为0。 spill_skew_percent integer 若发生下盘，数据库节点间下盘倾斜率。 min_dn_time bigint 语句在数据库节点上的最小执行时间，单位ms。 max_dn_time bigint 语句在数据库节点上的最大执行时间，单位ms。 average_dn_time bigint 语句在数据库节点上的平均执行时间，单位ms。 dntime_skew_percent integer 语句在数据库节点的执行时间倾斜率。 min_cpu_time bigint 语句在数据库节点上的最小CPU时间，单位ms。 max_cpu_time bigint 语句在数据库节点上的最大CPU时间，单位ms。 total_cpu_time bigint 语句在数据库节点上的CPU总时间，单位ms。 cpu_skew_percent integer 语句在数据库节点间的CPU时间倾斜率。 min_peak_iops integer 语句在数据库节点上的每秒最小I/O峰值（单位是万次/s）。 max_peak_iops integer 语句在数据库节点上的每秒最大I/O峰值（单位是万次/s）。 average_peak_iops integer 语句在数据库节点上的每秒平均I/O峰值（单位是万次/s）。 iops_skew_percent integer 语句在数据库节点间的I/O倾斜率。 warning text 主要显示如下几类告警信息： 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 queryid bigint 语句执行使用的内部query id。 query text 正在执行的语句。 query_plan text 语句的执行计划。 node_group text 语句所属用户对应的逻辑数据库。 top_cpu_dn text cpu使用量topN信息。 top_mem_dn text 内存使用量topN信息。 父主题： Query

GS_WLM_PLAN_OPERATOR_HISTORY GS_WLM_PLAN_OPERATOR_HISTORY视图显示的是当前用户数据库主节点上执行作业结束后的执行计划算子级的相关记录。 当查询视图无数据显示时，请联系华为技术工程师提供技术支持。 表1 GS_WLM_PLAN_OPERATOR_HISTORY字段 名称 类型 描述 datname name 收集计划信息所在的数据库名称。 queryid bigint 语句执行使用的内部query_id。 plan_node_id integer 查询对应的执行计划的plan node id。 startup_time bigint 该算子处理第一条数据的开始时间。 total_time bigint 该算子到结束时候总的执行时间（ms）。 actual_rows bigint 实际执行的行数信息。 max_peak_memory integer 当前算子在数据库节点上的最大内存峰值（MB）。 query_dop integer 当前算子执行时的并行度。 parent_node_id integer 当前算子的父节点node id。 left_child_id integer 当前算子的左孩子节点node id。 right_child_id integer 当前算子的右孩子节点node id。 operation text 当前算子进行的操作名称。 orientation text 当前算子的对齐方式。 strategy text 当前算子操作的实现方法。 options text 当前算子操作的选择方式。 condition text 当前算子操作的过滤条件。 projection text 当前算子的映射关系。 父主题： 负载管理

DBE_PLDEBUGGER Schema DBE_PLDEBUGGER Schema下的系统函数用于调试存储过程，目前支持的接口及其描述如下所示。 仅管理员有权限执行这些调试接口，但在该schema上无修改和创建新函数的权限。普通用户只能调试在public schema或用户创建schema下的非系统函数，禁止普通用户调试系统函数。 当在函数体中创建用户时，调用attach、next、continue、 info_code、step、info_breakpoint、backtrace、 finish中会返回密码的明文。因此不建议用户在函数体中创建用户。 当存储过程调试时，如果被调试的存储过程中涉及加锁的操作，请注意在调试端勿执行可能导致死锁的操作。 调试端和被调试端需连接在同一database，否则使用函数oid获取函数信息的接口将不可用。 对应权限角色为gs_role_pldebugger，可以由管理员用户通过如下命令将debugger权限赋权给该用户。 GRANT gs_role_pldebugger to user; 需要有两个客户端连接数据库，一个客户端负责执行调试接口作为debug端，另一个客户端执行调试函数，控制server端存储过程执行。示例如下： 准备调试 通过PG_PROC，查找到待调试存储过程的oid，并执行DBE_PLDEBUGGER.turn_on(oid)。本客户端会作为server端使用。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 gaussdb=# CREATE OR REPLACE PROCEDURE test_debug ( IN x INT) AS BEGIN INSERT INTO t1 (a) VALUES (x); DELETE FROM t1 WHERE a = x; END; / CREATE PROCEDURE gaussdb=# SELECT OID FROM PG_PROC WHERE PRONAME='test_debug'; oid ------- 16389 (1 row) gaussdb=# SELECT * FROM DBE_PLDEBUGGER.turn_on(16389); nodename | port ----------+------ datanode | 0 (1 row) 开始调试 server端执行存储过程，会在存储过程内第一条SQL语句前hang住，等待debug端发送的调试消息。仅支持直接执行存储过程的调试，不支持通过trigger调用执行的存储过程调试。 1 gaussdb=# call test_debug(1); 再起一个客户端，作为debug端，通过turn_on返回的数据，调用DBE_PLDEBUGGER.attach关联到该存储过程上进行调试。 1 2 3 4 5 gaussdb=# SELECT * FROM DBE_PLDEBUGGER.attach('datanode',0); funcoid | funcname | lineno | query ---------+------------+--------+---------------------------------- 16389 | test_debug | 3 | INSERT INTO t1 (a) VALUES (x); (1 row) 在执行attach的客户端调试，执行下一条statement。 1 2 3 4 5 gaussdb=# SELECT * FROM DBE_PLDEBUGGER.next(); funcoid | funcname | lineno | query ---------+------------+--------+---------------------- 16389 | test_debug | 0 | [EXECUTION FINISHED] (1 row) 在执行attach的客户端调试，可以执行以下变量操作。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 gaussdb=# SELECT * FROM DBE_PLDEBUGGER.info_locals(); --打印全部变量 varname | vartype | value | package_name | isconst ---------+---------+-------+--------------+--------- x | int4 | 1 | | f (1 row) gaussdb=# SELECT * FROM DBE_PLDEBUGGER.set_var('x', 2); --变量赋值 set_var --------- t (1 row) gaussdb=# SELECT * FROM DBE_PLDEBUGGER.print_var('x'); --打印单个变量 varname | vartype | value | package_name | isconst ---------+---------+-------+--------------+--------- x | int4 | 2 | | f (1 row) 直接执行完成当前正在调试的存储过程。 1 2 3 4 5 gaussdb=# SELECT * FROM DBE_PLDEBUGGER.continue(); funcoid | funcname | lineno | query ---------+------------+--------+---------------------- 16389 | test_debug | 0 | [EXECUTION FINISHED] (1 row) 当存储过程报错时，会出现以下提示，此时进入报错断住逻辑。 1 2 3 4 5 gaussdb=# SELECT * FROM DBE_PLDEBUGGER.continue(); funcoid | funcname | lineno | query ---------+------------+--------+------------------------------- 16389 | test_debug | 0 | [EXECUTION HAS ERROR OCCURRED!] (1 row) 此时进入报错断住逻辑，可以调用error_info_locals,error_backtrace,error_end,print_var接口查看信息，其他接口不能再使用，需要使用error_end结束当前报错断住。 1 2 3 4 5 gaussdb=# SELECT * FROM DBE_PLDEBUGGER.error_end(); funcoid | funcname | lineno | query ---------+------------+--------+------------------ 16389 | test_debug | 0 | [END HANG ERROR!] (1 row) 直接退出当前正在调试的存储过程(报错断住逻辑不可用)，不执行尚未执行的语句。 1 2 3 4 5 gaussdb=# SELECT * FROM DBE_PLDEBUGGER.abort(); abort ------- t (1 row) client端查看代码信息并识别可以设置断点行号。 1 2 3 4 5 6 7 8 9 10 11 gaussdb=# SELECT * FROM DBE_PLDEBUGGER.info_code(16389); lineno | query | canbreak --------+-----------------------------------------------------------+---------- | CREATE OR REPLACE PROCEDURE public.test_debug( IN x INT) | f 1 | AS DECLARE | f 2 | BEGIN | f 3 | INSERT INTO t1 (a) VALUES (x); | t 4 | DELETE FROM t1 WHERE a = x; | t 5 | END; | f 6 | / | f (7 rows) 设置断点。 1 2 3 4 5 gaussdb=# SELECT * FROM DBE_PLDEBUGGER.add_breakpoint(16389,4); breakpointno -------------- 0 (1 row) 查看断点信息。 1 2 3 4 5 gaussdb=# SELECT * FROM DBE_PLDEBUGGER.info_breakpoints(); breakpointno | funcoid | lineno | query | enable --------------+---------+--------+---------------------------------+-------- 0 | 16389 | 4 | DELETE FROM t1 WHERE a = x; | t (1 row) 执行至断点。 1 2 3 4 5 gaussdb=# SELECT * FROM DBE_PLDEBUGGER.continue(); funcoid | funcname | lineno | query ---------+------------+--------+--------------------------------- 16389 | test_debug | 4 | DELETE FROM t1 WHERE a = x; (1 row) 存储过程执行结束后，调试会自动退出，再进行调试需要重新attach关联。如果server端不需要继续调试，可执行turn_off关闭，或退出session。具体调试接口如表1所示。 表1 DBE_PLDEBUGGER 接口名称 描述 DBE_PLDEBUGGER.turn_on server端调用，标记存储过程可以调试，调用后执行该存储过程时会hang住等待调试信息。 DBE_PLDEBUGGER.turn_off server端调用，标记存储过程关闭调试。 DBE_PLDEBUGGER.local_debug_server_info server端调用，打印本session内所有已turn_on的存储过程。 DBE_PLDEBUGGER.attach debug端调用，关联到正在调试存储过程。 DBE_PLDEBUGGER.info_locals debug端调用，打印正在调试的存储过程中的变量当前值。 DBE_PLDEBUGGER.next debug端调用，单步执行。 DBE_PLDEBUGGER.continue debug端调用，继续执行，直到断点或存储过程结束。 DBE_PLDEBUGGER.abort debug端调用，停止调试，server端报错长跳转。 DBE_PLDEBUGGER.print_var debug端调用，打印正在调试的存储过程中指定的变量当前值。 DBE_PLDEBUGGER.info_code debug和server端都可以调用，打印指定存储过程的源语句和各行对应的行号。 DBE_PLDEBUGGER.step debug端调用，单步进入执行。 DBE_PLDEBUGGER.add_breakpoint debug端调用，新增断点。 DBE_PLDEBUGGER.delete_breakpoint debug端调用，删除断点。 DBE_PLDEBUGGER.info_breakpoints debug端调用，查看当前的所有断点。 DBE_PLDEBUGGER.backtrace debug端调用，查看当前的调用栈。 DBE_PLDEBUGGER.enable_breakpoint debug端调用，激活被禁用的断点。 DBE_PLDEBUGGER.disable_breakpoint debug端调用，禁用已激活的断点。 DBE_PLDEBUGGER.finish debug端调用，继续调试，直到断点或返回上一层调用栈。 DBE_PLDEBUGGER.set_var debug端调用，为变量进行赋值操作。 DBE_PLDEBUGGER.turn_on DBE_PLDEBUGGER.turn_off DBE_PLDEBUGGER.local_debug_server_info DBE_PLDEBUGGER.attach DBE_PLDEBUGGER.info_locals DBE_PLDEBUGGER.next DBE_PLDEBUGGER.continue DBE_PLDEBUGGER.abort DBE_PLDEBUGGER.print_var DBE_PLDEBUGGER.info_code DBE_PLDEBUGGER.step DBE_PLDEBUGGER.add_breakpoint DBE_PLDEBUGGER.delete_breakpoint DBE_PLDEBUGGER.info_breakpoints DBE_PLDEBUGGER.backtrace DBE_PLDEBUGGER.enable_breakpoint DBE_PLDEBUGGER.disable_breakpoint DBE_PLDEBUGGER.finish DBE_PLDEBUGGER.set_var DBE_PLDEBUGGER.error_backtrace DBE_PLDEBUGGER.error_end DBE_PLDEBUGGER.error_info_locals 父主题： Schema

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

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

application_name 参数说明：当前连接请求当中，所使用的客户端名称。该参数可在PDB级别设置。 参数类型：字符串 参数单位：无 取值范围：合法的客户端名称，实际查询结果取决于查询所用的客户端或用户设置。 在备机请求主机进行日志复制时，如果该参数非空串，那么会被用来作为备机在主机上的流复制槽名字。此时，如果该参数长度超过61个字节，那么流复制槽名字只会截取使用前61个字节的字符。 默认值：""（连接到后端的应用名，以实际安装为准）。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于USERSET类型参数，请参见表1中对应设置方法进行设置。但是需要注意的是，客户端连接后该参数会被设为客户端名称，且设置为客户端级别，所以只有设置会话级别的参数会生效，其他方式都由于级别低于客户端级别而不会生效。 设置建议：推荐使用默认值。 设置不当的风险与影响：数据库依赖于application_name标识部分内部进程，当用户设置了与内部进程同名的application_name时，可能产生非预期的行为。

plat_compat_server_port 参数说明：M-Compatibility模式数据库行为配置项。该参数用于设置协议侦听的TCP端口号。 参数类型：整型 参数单位：无 取值范围：1024 ~ 65536 默认值：65536，表示不启动监听端口。 设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。 设置建议：默认值65536，表示不启动监听端口，1024-65535属于有效监听端口，请设置为未被使用的端口。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

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

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_group 参数说明：设置Unix域套接字的所属组（套接字的所属用户总是启动服务器的用户）。可以与选项unix_socket_permissions一起用于对套接字进行访问控制。 参数类型：字符串 参数单位：无 取值范围：系统中已有的用户组。 默认值：""，表示当前用户的缺省组。 设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

unix_socket_permissions 参数说明：设置Unix域套接字的访问权限。 Unix域套接字使用普通的Unix文件系统权限集。这个参数的值应该是数值的格式（chmod和umask命令可接受的格式）。如果使用自定义的八进制格式，数字必须以0开头。 参数类型：整型 参数单位：无 取值范围：0000 ~ 0777 在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。 默认值：0700 设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。 设置建议：建议设置为0770（只有当前连接数据库的用户和同组的人可以访问）或者0700（只有当前连接数据库的用户自己可以访问，同组或者其他人都没有权限）。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

light_comm 参数说明：设置服务器是否使用轻量通信方式。 该参数指定服务器是否使用基于轻量锁和非阻塞socket的通信方式。 参数类型：布尔型 参数单位：无 取值范围： on：表示使用轻量通信方式。 off：表示不使用轻量通信方式。 默认值：off 设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

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

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