华为云用户手册

原型 1234 SQLRETURN SQLSetConnectAttr(SQLHDBC ConnectionHandle SQLINTEGER Attribute, SQLPOINTER ValuePtr, SQLINTEGER StringLength);

upgrade_mode 参数说明：标示升级模式。 该参数属于INTERNAL类型参数，为固定参数，用户无法修改此参数，只能查看。 取值范围：整数，0~INT_MAX 0表示不在升级过程中。 1表示在就地升级过程中。 2表示在灰度升级过程中。 默认值：0 特殊情况：在使用灰度升级的情况下，若选择策略为大版本升级，即需要执行升级脚本和替换二进制包，会将upgrade_mode设置为2，选择策略为小版本升级，只替换二进制包，则不会设置upgrade_mode设置为2。

原型 123456 SQLRETURN SQLGetData(SQLHSTMT StatementHandle, SQLUSMALLINT Col_or_Param_Num, SQLSMALLINT TargetType, SQLPOINTER TargetValuePtr, SQLLEN BufferLength, SQLLEN *StrLen_or_IndPtr);

参数 表1 SQLGetData参数 关键字 参数说明 StatementHandle 语句句柄，通过SQLAllocHandle获得。 Col_or_Param_Num 要返回数据的列号。结果集的列按增序从1开始编号。书签列的列号为0。 TargetType TargetValuePtr缓冲中的C数据类型的类型标识符。若TargetType为SQL_ARD_TYPE，驱动使用ARD中SQL_DESC_CONCISE_TYPE字段的类型标识符。若为SQL_C_DEFAULT，驱动根据源的SQL数据类型选择缺省的数据类型。 TargetValuePtr 输出参数：指向返回数据所在缓冲区的指针。 BufferLength TargetValuePtr所指向缓冲区的长度。 StrLen_or_IndPtr 输出参数：指向缓冲区的指针，在此缓冲区中返回长度或标识符的值。

返回值 SQL_SUCCESS：表示调用正确。 SQL_SUCCESS_WITH_INFO：表示会有一些警告信息。 SQL_NEED_DATA：表示在执行SQL语句前没有提供足够的参数。 SQL_ERROR：表示比较严重的错误，如：内存分配失败、建立连接失败等。 SQL_NO_DATA：表示SQL语句不返回结果集。 SQL_INVALID_HANDLE：表示调用无效句柄。其他API的返回值同理。 SQL_STILL_EXECUTING：表示语句正在执行。

注意事项 须使用CASCADE级联删除依赖用户的对象（除数据库外）。当删除用户的级联对象时，如果级联对象处于锁定状态，则此级联对象无法被删除，直到对象被解锁或锁定级联对象的进程被杀死。 在GaussDB中，存在一个配置参数enable_kill_query，此参数在配置文件postgresql.conf中。此参数影响级联删除用户对象的行为： 当参数enable_kill_query为on ，且使用CASCADE模式删除用户时，会自动kill锁定用户级联对象的进程，并删除用户。 当参数enable_kill_query为off，且使用CASCADE模式删除用户时，会等待锁定级联对象的进程结束之后再删除用户。 在数据库中删除用户时，如果依赖用户的对象在其他数据库中或者依赖用户的对象是其他数据库，请用户先手动删除其他数据库中的依赖对象或直接删除依赖数据库，再删除用户。即drop user不支持跨数据库进行级联删除。 在删除用户时，需要先删除该用户拥有的所有对象并且收回该用户在其他对象上的权限，或者通过指定CASCADE级联删除该用户拥有的对象和被授予的权限。 如果该用户被DATA SOURCE对象依赖时，无法直接级联删除该用户，需要手动删除对应的DATA SOURCE对象之后再删除该用户。

参数 表1 SQLFreeHandle参数 关键字 参数说明 HandleType SQLFreeHandle要释放的句柄类型。必须为下列值之一： SQL_HANDLE_ENV SQL_HANDLE_DBC SQL_HANDLE_STMT SQL_HANDLE_DESC 如果HandleType不是这些值之一，SQLFreeHandle返回SQL_INVALID_HANDLE。 Handle 要释放的句柄。

参数说明 IF EXISTS 如果指定的用户不存在，发出一个notice而不是抛出一个错误。 user_name 待删除的用户名。 取值范围：已存在的用户名。 CASCADE | RESTRICT CASCADE：级联删除依赖用户的对象，并收回授予该用户的权限。 RESTRICT：如果用户还有任何依赖的对象或被授予了其他对象的权限，则拒绝删除该用户（缺省行为）。 在GaussDB中，存在一个配置参数enable_kill_query，此参数在配置文件postgresql.conf中。此参数影响级联删除用户对象的行为： 当参数enable_kill_query为on ，且使用CASCADE模式删除用户时，会自动kill锁定用户级联对象的进程，并删除用户。 当参数enable_kill_query为off，且使用CASCADE模式删除用户时，会等待锁定级联对象的进程结束之后再删除用户。

STAT_USER_INDEXES 显示数据库中用户自定义普通表的索引状态信息。 表1 STAT_USER_INDEXES字段 名称 类型 描述 relid oid 此索引的表的OID。 indexrelid oid 索引的OID。 schemaname name 索引的模式名。 relname name 索引的表名。 indexrelname name 索引名。 idx_scan bigint 索引上开始的索引扫描数。 idx_tup_read bigint 通过索引上扫描返回的索引项数。 idx_tup_fetch bigint 通过使用索引的简单索引扫描抓取的活表行数。 父主题： Object

GLOBAL_STAT_USER_TABLES 得到各节点所有命名空间中用户自定义普通表的状态信息。 表1 GLOBAL_STAT_USER_TABLES字段 名称 类型 描述 node_name name 节点名称。 relid oid 表的OID。 schemaname name 此表的模式名。 relname name 表名。 seq_scan bigint 此表发起的顺序扫描数。 seq_tup_read bigint 顺序扫描抓取的活跃行数。 idx_scan bigint 此表发起的索引扫描数。 idx_tup_fetch bigint 索引扫描抓取的活跃行数。 n_tup_ins bigint 插入行数。 n_tup_upd bigint 更新行数。 n_tup_del bigint 删除行数。 n_tup_hot_upd bigint HOT更新行数（即没有更新所需的单独索引）。 n_live_tup bigint 估计活跃行数。 n_dead_tup bigint 估计死行数。 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 bigint 这个表被手动清理的次数（不计算VACUUM FULL）。 autovacuum_count bigint 这个表被autovacuum清理的次数。 analyze_count bigint 这个表被手动分析的次数。 autoanalyze_count bigint 这个表被autovacuum守护进程分析的次数。 父主题： Object

STAT_USER_TABLES 显示当前节点所有命名空间中用户自定义普通表的状态信息。 表1 STAT_USER_TABLES字段 名称 类型 描述 relid oid 表的OID。 schemaname name 该表的模式名。 relname name 表名。 seq_scan bigint 该表发起的顺序扫描数。 seq_tup_read bigint 顺序扫描抓取的活跃行数。 idx_scan bigint 该表发起的索引扫描数。 idx_tup_fetch bigint 索引扫描抓取的活跃行数。 n_tup_ins bigint 插入行数。 n_tup_upd bigint 更新行数。 n_tup_del bigint 删除行数。 n_tup_hot_upd bigint HOT更新行数（即没有更新所需的单独索引）。 n_live_tup bigint 估计活跃行数。 n_dead_tup bigint 估计死行数。 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 bigint 该表被手动清理的次数（不计算VACUUM FULL）。 autovacuum_count bigint 该表被autovacuum清理的次数。 analyze_count bigint 该表被手动分析的次数。 autoanalyze_count bigint 该表被autovacuum守护进程分析的次数。 父主题： Object

GLOBAL_REL_IOSTAT 获取所有节点上的数据文件IO统计信息。 表1 GLOBAL_REL_IOSTAT字段 名称 类型 描述 node_name name 节点名称。 phyrds bigint 读物理文件的数目。 phywrts bigint 写物理文件的数目。 phyblkrd bigint 读物理文件块的数目。 phyblkwrt bigint 写物理文件块的数目。 父主题： File

FILE_REDO_IOSTAT 本节点Redo(WAL)相关的统计信息。 表1 FILE_REDO_IOSTAT字段 名称 类型 描述 phywrts bigint 向wal buffer中写的次数。 phyblkwrt bigint 向wal buffer中写的block的块数。 writetim bigint 向xlog文件中写操作的时间（单位：微秒）。 avgiotim bigint 平均写xlog的时间（writetim/phywrts，单位：微秒）。 lstiotim bigint 最后一次写xlog的时间（单位：微秒）。 miniotim bigint 最小的写xlog时间（单位：微秒）。 maxiowtm bigint 最大的写xlog时间（单位：微秒）。 父主题： File

GLOBAL_FILE_IOSTAT 得到所有节点上的数据文件IO 统计信息。 表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

LOCAL_REL_IOSTAT 获取当前节点中数据文件IO状态的累计值，显示为所有数据文件IO状态的总和。 表1 LOCAL_REL_IOSTAT字段 名称 类型 描述 phyrds bigint 读物理文件的数目。 phywrts bigint 写物理文件的数目。 phyblkrd bigint 读物理文件的块的数目。 phyblkwrt bigint 写物理文件的块的数目。 父主题： File

SUMMARY_FILE_REDO_IOSTAT 数据库内汇聚所有的Redo(WAL）相关的统计信息。 表1 SUMMARY_FILE_REDO_IOSTAT字段 名称 类型 描述 phywrts numeric 向wal buffer中写的次数。 phyblkwrt numeric 向wal buffer中写的block的块数。 writetim numeric 向xlog文件中写操作的时间（单位：微秒）。 avgiotim bigint 平均写xlog的时间（writetim/phywrts，单位：微秒）。 lstiotim bigint 最后一次写xlog的时间（单位：微秒）。 miniotim bigint 最小的写xlog时间（单位：微秒）。 maxiowtm bigint 最大的写xlog时间（单位：微秒）。 父主题： File

SUMMARY_FILE_IOSTAT 通过数据库内对数据文件汇聚IO的统计，反映数据的IO性能，用以发现IO操作异常等性能问题。 表1 SUMMARY_FILE_IOSTAT字段 名称 类型 描述 filenum oid 文件标识。 dbid oid 数据库标识。 spcid oid 表空间标识。 phyrds numeric 读物理文件的数目。 phywrts numeric 写物理文件的数目。 phyblkrd numeric 读物理文件块的数目。 phyblkwrt numeric 写物理文件块的数目。 readtim numeric 读文件的总时长（单位：微秒）。 writetim numeric 写文件的总时长（单位：微秒）。 avgiotim bigint 读写文件的平均时长（单位：微秒）。 lstiotim bigint 最后一次读文件时长（单位：微秒）。 miniotim bigint 读写文件的最小时长（单位：微秒）。 maxiowtm bigint 读写文件的最大时长（单位：微秒）。 父主题： File

FILE_IOSTAT 通过对数据文件IO的统计，反映数据的IO性能，用以发现IO操作异常等性能问题。 表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

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

MEMORY_NODE_DETAIL 显示某个数据库节点内存使用情况。 表1 MEMORY_NODE_DETAIL字段 名称 类型 描述 nodename text 节点名称。 memorytype text 内存的名称。 max_process_memory：GaussDB实例所占用的内存大小。 process_used_memory：进程所使用的内存大小。 max_dynamic_memory：最大动态内存。 dynamic_used_memory：已使用的动态内存。 dynamic_peak_memory：内存的动态峰值。 dynamic_used_shrctx：最大动态共享内存上下文。 dynamic_peak_shrctx：共享内存上下文的动态峰值。 max_shared_memory：最大共享内存。 shared_used_memory：已使用的共享内存。 max_cstore_memory：列存所允许使用的最大内存。 cstore_used_memory：列存已使用的内存大小。 max_sctpcomm_memory：TCP代理通信所允许使用的最大内存。 sctpcomm_used_memory：TCP代理通信已使用的内存大小。 sctpcomm_peak_memory：TCP代理通信的内存峰值。 other_used_memory：其他已使用的内存大小。 gpu_max_dynamic_memory：GPU最大动态内存。 gpu_dynamic_used_memory：GPU已使用的动态内存。 gpu_dynamic_peak_memory：GPU内存的动态峰值。 pooler_conn_memory：链接池申请内存计数。 pooler_freeconn_memory：链接池空闲连接的内存计数。 storage_compress_memory：存储模块压缩使用的内存大小。 udf_reserved_memory：UDF预留的内存大小。 memorymbytes integer 内存使用的大小，单位为MB。 父主题： Memory

GLOBAL_MEMORY_NODE_DETAIL 显示当前数据库中所有正常节点下的内存使用情况。 表1 GLOBAL_MEMORY_NODE_DETAIL字段 名称 类型 描述 nodename text 节点名称。 memorytype text 内存使用的名称。 max_process_memory：数据库实例所占用的内存大小。 process_used_memory：进程所使用的内存大小。 max_dynamic_memory：最大动态内存。 dynamic_used_memory：已使用的动态内存。 dynamic_peak_memory：内存的动态峰值。 dynamic_used_shrctx：最大动态共享内存上下文。 dynamic_peak_shrctx：共享内存上下文的动态峰值。 max_shared_memory：最大共享内存。 shared_used_memory：已使用的共享内存。 max_cstore_memory：列存所允许使用的最大内存。 cstore_used_memory：列存已使用的内存大小。 max_sctpcomm_memory：TCP代理通信所允许使用的最大内存。 sctpcomm_used_memory：TCP代理通信已使用的内存大小。 sctpcomm_peak_memory：TCP代理通信的内存峰值。 other_used_memory：其他已使用的内存大小。 gpu_max_dynamic_memory：GPU最大动态内存。 gpu_dynamic_used_memory：GPU已使用的动态内存。 gpu_dynamic_peak_memory：GPU内存的动态峰值。 pooler_conn_memory：链接池申请内存计数。 pooler_freeconn_memory：链接池空闲连接的内存计数。 storage_compress_memory：存储模块压缩使用的内存大小。 udf_reserved_memory：UDF预留的内存大小。 memorymbytes integer 内存使用的大小，单位为MB。 父主题： Memory

GLOBAL_SHARED_MEMORY_DETAIL 查询数据库中所有正常节点下的共享内存上下文的使用信息。 表1 GLOBAL_SHARED_MEMORY_DETAIL字段 名称 类型 描述 node_name name 节点名称。 contextname text 内存上下文的名称。 level smallint 内存上下文的级别。 parent text 上级内存上下文。 totalsize bigint 共享内存总大小（单位：字节）。 freesize bigint 共享内存剩余大小（单位：字节）。 usedsize bigint 共享内存使用大小（单位：字节）。 父主题： Memory

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

Schema GaussDB的Schema如下表所示。 表1 GaussDB支持的Schema Schema名称 描述 blockchain 用于存储账本数据库特性（当前特性是实验室特性，使用时请联系华为工程师提供技术支持）中创建防篡改表时自动创建的用户历史表。 cstore 该模式用于储存列存表相关的辅助表如cudesc或者delta表。 db4ai 用于管理AI训练中不同版本的数据信息。 dbe_perf DBE_PERF Schema内视图主要用来诊断性能问题，也是WDR Snapshot的数据来源。数据库安装后，默认只有初始用户和监控管理员具有模式dbe_perf的权限，有权查看该模式下的视图和函数。 dbe_pldebugger 用于调试plpgsql函数及存储过程。 snapshot 用于管理WDR snapshot的相关的数据信息，默认初始化用户或监控管理员用户可以访问。 sqladvisor 用于分布列推荐，集中式不可用。 sys 用于提供系统信息视图接口。 pg_catalog 用于维护系统的catalog信息，包含系统表和所有内置数据类型、函数、操作符。 pg_toast 用于存储大对象（系统内部使用）。 public 公共模式，缺省时，创建的表(以及其它对象)自动放入该模式。 pkg_service 用于管理package服务相关信息。 pkg_util 用于管理package工具相关信息。 dbe_raw 高级功能包dbe_raw，用于raw类型数据的转化、取子串、求长度等操作。 dbe_session 高级功能包dbe_session，用于设置指定属性的值（value），并支持用户查询校验。 dbe_lob 高级功能包dbe_lob，用于大文件（clob/blob）的读取、写入、复制等操作。 dbe_match 高级功能包dbe_match，用于字符串相似度的比较。 dbe_task 高级功能包dbe_task，用于作业任务的调度包括提交任务、取消任务、同步任务状态、更新任务信息等可以使数据库定期执行特定的任务。 dbe_sql 高级功能包dbe_sql，用于执行动态sql，可以在应用的运行时间构建查询和其他命令。 dbe_file 高级功能包dbe_file，用于数据库外部数据的读取、复制、写入、删除、重命名等。 dbe_output 高级功能包dbe_output，用于打印输出信息。 dbe_random 高级功能包dbe_random，用于生成随机种子和随机数。 dbe_application_info 高级功能包dbe_application_info，用于记录客户端信息。 dbe_utility 高级功能包dbe_utility，用于在存储过程中调用调试工具，例如查看错误堆栈等。 dbe_scheduler 高级功能包dbe_scheduler，用于创建定时任务，通过程序(program)，调度(schedule)使数据库定期执行特定的任务。也可以通过授权、提供证书执行数据库外部任务。 information_schema 用于存储有关当前数据库中定义的对象的信息。 dbe_pldeveloper 用户存储过程编译调试。 DBE_PERF Schema WDR Snapshot Schema DBE_PLDEBUGGER Schema DBE_SQL_UTIL Schema

INSTANCE_TIME 提供当前数据库节点下的各种时间消耗信息，主要分为以下类型： DB_TIME：作业在多核下的有效时间花销。 CPU_TIME：CPU的时间花销。 EXECUTION_TIME：执行器内的时间花销。 PARSE_TIME：SQL解析的时间花销。 PLAN_TIME：生成Plan的时间花销。 REWRITE_TIME：SQL重写的时间花销。 PL_EXECUTION_TIME ：plpgsql（存储过程）执行的时间花销。 PL_COMPILATION_TIME：plpgsql（存储过程）编译的时间花销。 NET_SEND_TIME：网络上的时间花销。 DATA_IO_TIME：IO上的时间花销。 表1 INSTANCE_TIME字段 名称 类型 描述 stat_id integer 统计编号。 stat_name text 类型名称。 value bigint 时间值（单位：微秒）。 父主题： Instance

GLOBAL_INSTANCE_TIME 提供数据库中所有正常节点下的各种时间消耗信息（时间类型见instance_time视图）。 表1 GLOBAL_INSTANCE_TIME字段 名称 类型 描述 node_name name 节点名称。 stat_id integer 统计编号。 stat_name text 类型名称。 value bigint 时间值（单位：微秒）。 父主题： Instance

PLAN_TABLE PLAN_TABLE显示用户通过执行EXPLAIN PLAN收集到的计划信息。计划信息的生命周期是session级别，session退出后相应的数据将被清除。同时不同session和不同user间的数据是相互隔离的。 表1 PLAN_TABLE字段 名称 类型 描述 statement_id varchar2(30) 用户输入的查询标签。 plan_id bigint 查询标识。 id int 查询生成的计划中的每一个执行算子的编号。 operation varchar2(30) 计划中算子的操作描述。 options varchar2(255) 操作选项。 object_name name 操作对应的对象名，非查询中使用到的对象别名。来自于用户定义。 object_type varchar2(30) 对象类型。 object_owner name 对象所属schema，来自于用户定义。 projection varchar2(4000) 操作输出的列信息。 cost float8 优化器对算子估算的执行代价。 cardinality float8 优化器对算子估算的结果行数。 object_type取值范围为PG_CLASS中定义的relkind类型（TABLE普通表，INDEX索引，SEQUENCE序列，VIEW视图，COMPOSITE TYPE复合类型，TOASTVALUE TOAST表）和计划使用到的rtekind(SUBQUERY, JOIN, FUNCTION, VALUES, CTE, REMOTE_QUERY)。 object_owner对于RTE来说是计划中使用的对象描述，非用户定义的类型不存在object_owner。 statement_id、object_name、object_owner、projection字段内容遵循用户定义的大小写存储，其它字段内容采用大写存储。 支持用户对PLAN_TABLE进行SELECT和DELETE操作，不支持其它DML操作。 父主题： 系统视图

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

GLOBAL_OS_RUNTIME 提供数据库中所有正常节点下的操作系统运行状态信息。 表1 GLOBAL_OS_RUNTIME字段 名称 类型 描述 node_name name 节点名称。 id integer 编号。 name text 操作系统运行状态名称。 value numeric 操作系统运行状态值。 comments text 操作系统运行状态注释。 cumulative boolean 操作系统运行状态的值是否为累加值。 父主题： OS

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