华为云用户手册

DBE_PLDEBUGGER.finish 执行存储过程中当前的SQL直到下一个断点触发或执行到上层栈的下一行。 表1 finish入参和返回值列表 名称 类型 描述 funcoid OUT oid 函数id funcname OUT text 函数名 lineno OUT integer 当前调试运行的下一行行号 query OUT text 当前调试的下一行函数源码 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.backtrace debug端调试过程中，调用backtrace，查看当前的调用堆栈。 表1 backtrace返回值列表 名称 类型 描述 frameno OUT integer 调用栈编号 funcname OUT text 函数名 lineno OUT integer 行号 query OUT text 断点内容 funcoid OUT oid 函数oid 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.info_breakpoints debug端调试过程中，调用info_breakpoints，查看当前的函数断点。 表1 info_breakpoints返回值列表 名称 类型 描述 breakpointno OUT integer 断点编号 funcoid OUT oid 函数ID lineno OUT integer 行号 query OUT text 断点内容 enable OUT boolean 是否有效 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.add_breakpoint debug端调试过程中，调用add_breakpoint增加新的断点。如果返回-1则说明指定的断点不合法，请参考DBE_PLDEBUGGER.info_code的canbreak字段确定断点合适的位置。 表1 add_breakpoint入参和返回值列表 名称 类型 描述 funcoid IN text 函数ID lineno IN integer 行号 breakpointno OUT integer 断点编号 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.step debug端调试过程中，如果当前执行的是一个存储过程，则进入该存储过程继续调试，返回该存储过程第一行的行号等信息，如果当前执行的不是存储过程，则和next行为一致，执行该sql后返回下一行的行号等信息。 表1 step入参和返回值列表 名称 类型 描述 funcoid OUT oid 函数ID funcname OUT text 函数名 lineno OUT integer 当前调试运行的下一行行号 query OUT text 当前调试的下一行函数源码 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.info_code debug端调试过程中，调用info_code，查看指定存储过程的源语句和各行对应的行号，行号从函数体开始，函数头部分行号为空。 表1 info_code入参和返回值列表 名称 类型 描述 funcoid IN oid 函数ID lineno OUT integer 行号 query OUT text 源语句 canbreak OUT bool 当前行是否支持断点 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.print_var debug端调试过程中，调用print_var，打印当前存储过程内变量中指定的变量名及其取值。该函数入参frameno表示查询遍历的栈层数，支持不加入该参数调用，缺省为查看最上层栈变量。 表1 print_var入参和返回值列表 名称 类型 描述 var_name IN text 变量 frameno IN integer（可选） 指定的栈层数，缺省为最顶层 varname OUT text 变量名 vartype OUT text 变量类型 value OUT text 变量值 package_name OUT text 变量对应的package名，预留使用，当前均为空 isconst OUT boolean 是否为常量 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.continue 执行当前存储过程，直到下一个断点或结束，返回执行的下一条的行数和对应query。 函数原型为： 1 2 DBE_PLDEBUGGER.continue() RETURN Record; 表1 continue 返回值列表 名称 类型 描述 funcoid OUT oid 函数id funcname OUT text 函数名 lineno OUT integer 当前调试运行的下一行行号 query OUT text 当前调试的下一行函数源码 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.next 执行存储过程中当前的sql，返回执行的下一条的行数和对应query。 表1 next返回值列表 名称 类型 描述 funcoid OUT oid 函数id funcname OUT text 函数名 lineno OUT integer 当前调试运行的下一行行号 query OUT text 当前调试的下一行函数源码 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.info_locals debug端调试过程中，调用info_locals，打印当前存储过程内变量。该函数入参frameno表示查询遍历的栈层数，支持无入参调用，缺省为查看最上层栈变量。 表1 info_locals入参和返回值列表 名称 类型 描述 frameno IN integer （可选） 指定的栈层数，缺省为最顶层 varname OUT text 变量名 vartype OUT text 变量类型 value OUT text 变量值 package_name OUT text 变量对应的package名，非package时为空 isconst OUT boolean 是否为常量 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.attach server端执行存储过程，停在第一条语句前，等待debug端关联。debug端调用attach，传入nodename和port，关联到该存储过程上。 如果调试过程中报错，attach会自动失效；如果调试过程中attach到其他存储过程上，当前attach的调试也会失效。 表1 attach 入参和返回值列表 名称 类型 描述 nodename IN text 节点名称 port IN integer 连接端口号 funcoid OUT oid 函数id funcname OUT text 函数名 lineno OUT integer 当前调试运行的下一行行号 query OUT text 当前调试的下一行函数源码 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.local_debug_server_info 用于查找当前连接中已经turn_on的存储过程oid。便于用户确认在调试哪些存储过程，需要通过funcoid和pg_proc配合使用。 表1 local_debug_server_info 返回值列表 名称 类型 描述 nodename OUT text 节点名称 port OUT bigint 端口号 funcoid OUT oid 存储过程oid 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.turn_off 用于去掉turn_on添加的调试标记，返回值表示成功或失败。可通过DBE_PLDEBUGGER.local_debug_server_info查找已经turn_on的存储过程oid。 函数原型为： 1 2 DBE_PLDEBUGGER.turn_off(Oid) RETURN boolean; 表1 turn_off 入参和返回值列表 名称 类型 描述 func_oid IN oid 函数oid turn_off OUT boolean turn off是否成功 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.turn_on 该函数用于标记某一存储过程为可调试，执行turn_on后server端可以执行该存储过程来进行调试。需要用户根据系统表PG_PROC手动获取存储过程oid，传入函数中。turn_on后本session内执行该存储过程会停在第一条sql前等待debug端的调试操作。该设置会在session断连后默认被清理掉。目前不支持对启用自治事务的存储过程/函数进行调试。 函数原型为： 1 2 DBE_PLDEBUGGER.turn_on(Oid) RETURN Record; 表1 turn_on 入参和返回值列表 名称 类型 描述 func_oid IN oid 函数oid nodename OUT text 节点名称 port OUT integer 连接端口号 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER Schema DBE_PLDEBUGGER Schema下的系统函数用于调试存储过程，目前支持的接口及其描述如下所示。仅管理员有权限执行这些调试接口，但无权限在该schema上修改和创建新函数。普通用户只能调试在public schema或用户创建schema下的非系统函数，禁止普通用户调试系统函数。 当在函数体中创建用户时，调用attach、next、continue、 info_code、step、info_breakpoint、backtrace、 finish中会返回密码的明文。因此不建议用户在函数体中创建用户。 对应权限角色为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.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 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 父主题： Schema

SQL Detail SQL Detail列名称及描述如下表所示。 表1 SQL Detail报表主要内容 列名称 描述 Unique SQL Id 归一化SQL ID。 Parent Unique SQL Id 父语句的归一化SQL ID，单独执行的语句该值为0。 User Name 用户名称。 Node Name 节点名称。Node模式下不显示该字段。 SQL Text 归一化SQL文本。 父主题： WDR报告信息介绍

Configuration settings Configuration settings列名称及描述如下表所示。 表1 Configuration settings报表主要内容 列名称 描述 Name GUC名称。 Abstract GUC描述。 Type 数据类型。 Current Value 当前值。 Min Value 合法最小值。 Max Value 合法最大值。 Category GUC类别。 Enum Values 如果是枚举值，列举所有枚举值。 Default Value 数据库启动时参数默认值。 Reset Value 数据库重置时参数默认值。 父主题： WDR报告信息介绍

User Tables stats 表1 User Tables stats报表主要内容 列名称 描述 Node Name 节点名称。 DB Name Database名称。 Schema Schema名称。 Relname Relation名称。 Seq Scan 此表发起的顺序扫描数。 Seq Tup Read 顺序扫描抓取的活跃行数。 Index Scan 此表发起的索引扫描数。 Index Tup Fetch 索引扫描抓取的活跃行数。 Tuple Insert 插入行数。 Tuple Update 更新行数。 Tuple Delete 删除行数。 Tuple Hot Update HOT更新行数（即没有更新所需的单独索引）。 Live Tuple 估计活跃行数。 Dead Tuple 估计死行数。 Last Vacuum 最后一次此表是手动清理的（不计算VACUUM FULL）时间。 Last Autovacuum 上次被autovacuum守护进程清理的时间。 Last Analyze 上次手动分析这个表的时间。 Last Autoanalyze 上次被autovacuum守护进程分析的时间。 Vacuum Count 这个表被手动清理的次数（不计算VACUUM FULL）。 Autovacuum Count 这个表被autovacuum清理的次数。 Analyze Count 这个表被手动分析的次数。 Autoanalyze Count 这个表被autovacuum守护进程分析的次数。

User index stats 表2 User index stats报表主要内容 列名称 描述 Node Name 节点名称。 DB Name Database名称。 Schema Schema名称。 Relname Relation名称。 Index Relname Index名称。 Index Scan 索引上开始的索引扫描数。 Index Tuple Read 通过索引上扫描返回的索引项数。 Index Tuple Fetch 通过使用索引的简单索引扫描抓取的表行数。

Replication stat 表2 Replication stat报表主要内容 列名称 描述 Thread Id 线程的PID。 Usesys Id 用户系统ID。 Usename 用户名称。 Application Name 应用程序。 Client Addr 客户端地址。 Client Hostname 客户端主机名。 Client Port 客户端端口。 Backend Start 程序起始时间。 State 日志复制状态。 Sender Sent Location 发送端发送日志位置。 Receiver Write Location 接收端write日志位置。 Receiver Flush Location 接收端flush日志位置。 Receiver Replay Location 接收端replay日志位置。 Sync Priority 同步优先级。 Sync State 同步状态。

User index IO activity 表2 User index IO activity 表格字段 列名称 描述 Node Name 节点名称。 DB Name Database名称。 Schema Name Schema名称。 Table Name Table名称。 Index Name Index名称。 %Idx Blks Hit Ratio Index的命中率。 Idx Blks Read 所有索引读取的磁盘块数。 Idx Blks Hit 所有索引命中缓存数。

User table IO activity 表1 User table IO activity表格字段 列名称 描述 Node Name 节点名称。 DB Name Database名称。 Schema Name Schema名称。 Table Name Table名称。 %Heap Blks Hit Ratio 此表的Buffer Pool命中率。 Heap Blks Read 该表中读取的磁盘块数。 Heap Blks Hit 此表缓存命中数。 Idx Blks Read 表中所有索引读取的磁盘块数。 Idx Blks Hit 表中所有索引命中缓存数。 Toast Blks Read 此表的TOAST表读取的磁盘块数（如果存在）。 Toast Blks Hit 此表的TOAST表命中缓冲区数（如果存在）。 Tidx Blks Read 此表的TOAST表索引读取的磁盘块数（如果存在）。 Tidx Blks Hit 此表的TOAST表索引命中缓冲区数（如果存在）。

Wait Events Wait Events列名称及描述如下表所示。 表1 Wait Events报表主要内容 列名称 描述 Type Wait Event类别名称： STATUS。 LWLOCK_EVENT。 LOCK_EVENT。 IO_EVENT。 Event Wait Event名称。 Total Wait Time (us) 总Wait时间（us）。 Waits 总Wait次数。 Failed Waits Wait失败次数。 Avg Wait Time (us) 平均Wait时间（us）。 Max Wait Time (us) 最大Wait时间（us）。 父主题： WDR报告信息介绍

SQL Statistics SQL Statistics列名称及描述如下表所示。 表1 SQL Statistics报表主要内容 列名称 描述 Unique SQL Id 归一化的SQL ID。 Parent Unique SQL Id 父语句的归一化SQL ID，对于非存储过程子语句的场景，该值为0。 Node Name 节点名称。 User Name 用户名称。 Avg Tuples Fetched 平均随机扫描行。 Avg Tuples Returned 平均顺序扫描行。 Calls 调用次数。 Total Elapse Time(us) 总执行时间（us）。 Avg Elapse Time(us) 平均执行时间（us）。 Returned Rows SELECT返回行数。 Avg Returned Rows 平均SELECT返回行数。 Tuples Affected Insert/Update/Delete行数。 Avg Tuples Affected 平均Insert/Update/Delete行数。 Logical Read Buffer逻辑读次数。 Avg Logical Read 平均Buffer逻辑读次数。 Physical Read Buffer物理读次数。 Avg Physical Read 平均Buffer物理读次数。 CPU Time(us) CPU时间（us）。 Avg CPU Time(us) 平均CPU时间（us）。 Data IO Time(us) IO上的时间花费（us）。 Avg Data IO Time(us) 平均IO上的时间花费（us）。 Sort Count 排序执行的次数。 Sort Time(us) 排序执行的时间（us）。 Sort Mem Used(KB) 排序过程中使用的work memory大小（KB）。 Sort Spill Count 排序过程中，若发生落盘，写文件的次数。 Sort Spill Size(KB) 排序过程中，若发生落盘，使用的文件大小（KB）。 Hash Count hash执行的次数。 Hash Time(us) hash执行的时间（us）。 Hash Mem Used(KB) hash过程中使用的work memory大小（KB）。 Hash Spill Count hash过程中，若发生落盘，写文件的次数。 Hash Spill Size(KB) hash过程中，若发生落盘，使用的文件大小（KB）。 SQL Text 归一化SQL字符串。 父主题： WDR报告信息介绍

Time Model Time Model名称及描述如下表所示。 表1 Time Model报表主要内容 名称 描述 DB_TIME 所有线程端到端的墙上时间（WALL TIME）消耗总和（单位：微秒）。 EXECUTION_TIME 消耗在执行器上的时间总和（单位：微秒)。 PL_EXECUTION_TIME 消耗在plpgsql执行上的时间总和（单位：微秒）。 CPU_TIME 所有线程CPU时间消耗总和（单位：微秒）。 PLAN_TIME 消耗在执行计划生成上的时间总和（单位：微秒）。 REWRITE_TIME 消耗在查询重写上的时间总和（单位：微秒）。 PL_COMPILATION_TIME 消耗在SQL编译上的时间总和（单位：微秒）。 PARSE_TIME 消耗在SQL解析上的时间总和（单位：微秒）。 NET_SEND_TIME 消耗在网络发送上的时间总和（单位：微秒）。 DATA_IO_TIME 消耗在数据读写上的时间总和（单位：微秒）。 父主题： WDR报告信息介绍

Memory Statistics Memory Statistics指标名称及描述如下表所示。 表1 Memory Statistics报表主要内容 指标名称 描述 shared_used_memory 已经使用共享内存大小（MB）。 max_shared_memory 最大共享内存（MB）。 process_used_memory 进程已经使用内存（MB）。 max_process_memory 最大进程内存（MB）。 父主题： WDR报告信息介绍

IO Profile IO Profile指标名称及描述如下表所示。 表1 IO Profile指标表主要内容 指标名称 描述 Database requests Database I/O次数。 Database (MB) Database I/O数据量。 Database (blocks) Database I/O数据块。 Redo requests Redo I/O次数。 Redo (MB) Redo I/O量。 父主题： WDR报告信息介绍

Host CPU Host CPU列名称及描述如下表所示。 表1 Host CPU报表主要内容 列名称 描述 Cpus CPU数量。 Cores CPU核数。 Sockets CPU Sockets数量。 Load Average Begin 开始Snapshot的Load Average值。 Load Average End 结束Snapshot的Load Average值。 %User 用户态在CPU时间上的占比。 %System 内核态在CPU时间上的占比。 %WIO Wait IO在CPU时间上的占比。 %Idle 空闲时间在CPU时间上的占比。 父主题： WDR报告信息介绍

Wait Classes by Total Wait Time Wait Classes by Total Wait Time列名称及描述如下表所示。 表1 Wait Classes by Total Wait Time报表主要内容 列名称 描述 Type Wait Event类别名称： STATUS。 LWLOCK_EVENT。 LOCK_EVENT。 IO_EVENT。 Waits Wait次数。 Total Wait Time(us) 总Wait时间（微秒）。 Avg Wait Time(us) 平均Wait时间（微秒）。 父主题： WDR报告信息介绍

Top 10 Events by Total Wait Time Top 10 Events by Total Wait Time列名称及描述如下表所示。 表1 Top 10 Events by Total Wait Time报表主要内容 列名称 描述 Event Wait Event名称。 Waits wait次数。 Total Wait Time(us) 总wait时间（微秒）。 Avg Wait Time(us) 平均wait时间（微秒）。 Type Wait Event类别。 父主题： WDR报告信息介绍