华为云用户手册

功能描述 优化器支持一系列查询改写规则，可以对SQL语句进行等价的逻辑改写，从而生成更好的执行计划。但在一些场景下，用户并不希望改写SQL语句、或者优化器的改写会导致计划跳变，对于这些特定的场景，需要能够使用hint对改写规则进行控制，让优化器按照特定的方式进行改写。目前数据库支持对ANY/EXISTS的子链接、简单子查询、消减ORDER BY、HAVING子句下推、延迟聚合等多种场景的SQL进行hint控制，具体请参见：Hint使用说明。 部分查询改写规则同时受查询改写的hint和GUC参数控制，通常查询改写的hint优先级高于GUC参数控制，涉及到受GUC参数控制的改写规则会在Hint使用说明相关章节进行描述。 每条查询改写规则受一对互斥的hint控制，如：子查询展开的规则同时受EXPAND_SUBQUERY和NO_EXPAND_SUBQUERY控制，其中，EXPAND_SUBQUERY Hint表示允许应用该规则对SQL进行改写，NO_EXPAND_SUBQUERY表示禁止使用该规则对SQL进行改写。且当同一个查询块（queryblock）中同时存在两个互斥的hint时，以获取的首个hint为准，例如：/*+ EXPAND_SUBQUERY NO_EXPAND_SUBQUERY */，则EXPAND_SUBQUERY Hint生效。 查询改写的hint允许重复，但对于重复的hint数据库只会使用第一个，对于其他未使用的hint则会报"unused hint" Warning提示。例如：/*+ EXPAND_SUBLINK EXPAND_SUBLINK */，由于数据库只使用第一个EXPAND_SUBLINK hint，所以仍然会报"unused hint" Warning提示。

查询改写Hint列表 表1 查询改写支持的hint列表 序号 hint名称 描述 1 EXPAND_SUBLINK_HAVING 允许HAVING子句中的子链接提升。 2 NO_EXPAND_SUBLINK_HAVING 禁止HAVING子句中的子链接提升。 3 EXPAND_SUBLINK 允许对ANY/EXISTS类型子链接进行提升。 4 NO_EXPAND_SUBLINK 禁止对ANY/EXISTS类型子链接进行提升。 5 EXPAND_SUBLINK_TARGET 允许对TargetList中的子链接进行提升。 6 NO_EXPAND_SUBLINK_TARGET 禁止对TargetList中的子链接进行提升。 7 USE_MAGIC_SET 从主查询下推条件到子查询，先针对子查询的关联字段进行分组聚集，再和主查询进行关联，减少相关子链接的重复扫描，提升查询效率。 8 NO_USE_MAGIC_SET 禁止从主查询下推条件到子查询，将带有聚集算子的子查询提前和主查询进行关联。 9 EXPAND_SUBLINK_UNIQUE_CHECK 允许对无agg的子链接进行提升，子链接提升需要保证对于每个条件只有一行输出。 10 NO_EXPAND_SUBLINK_UNIQUE_CHECK 禁止对无agg的子链接进行提升。 11 NO_SUBLINK_DISABLE_REPLICATED 允许带有复制表的fast query shipping或者Stream场景的表达式子链接提升。 12 SUBLINK_DISABLE_REPLICATED 禁止带有复制表的fast query shipping或者Stream场景的表达式子链接提升。 13 NO_SUBLINK_DISABLE_EXPR 允许对表达式类型的子链接进行提升。 14 SUBLINK_DISABLE_EXPR 禁止对表达式类型的子链接进行提升。 15 ENABLE_SUBLINK_ENHANCED 允许子链接提升增强，支持对OR表达式等相关或非相关子链接提升。 16 NO_ENABLE_SUBLINK_ENHANCED 禁用子链接提升增强，禁止对OR表达式等相关或非相关子链接提升。 17 PARTIAL_PUSH Stream场景支持对listagg和arrayagg添加gather算子。 18 NO_PARTIAL_PUSH Stream场景禁止对listagg和arrayagg添加gather算子。 19 REDUCE_ORDER_BY 消减冗余的ORDER BY，外层查询对内层查询结果无排序要求时，可以减少不必要的ORDER BY提升查询效率。 20 NO_REDUCE_ORDER_BY 禁止消减不必要的ORDER BY。 21 REMOVE_NOT_NULL 消减不必要的NOT NULL条件，当列属性为NOT NULL时，可以消减查询条件中的IS NOT NULL判断。 22 NO_REMOVE_NOT_NULL 禁止消减IS NOT NULL条件判断。 23 LAZY_AGG 子查询与外层查询存在同样的GROUP BY条件，两层聚集运算可能导致查询效率低下，消除子查询中的聚集运算，以此提高查询效率。 24 NO_LAZY_AGG 禁用消除子查询中的聚集运算规则。 25 EXPAND_SUBQUERY 子查询提升，将子查询提升与上层做JOIN连接，优化查询效率。 26 NO_EXPAND_SUBQUERY 禁用子查询提升。 27 PUSHDOWN_HAVING 下推HAVING条件表达式。 28 NO_PUSHDOWN_HAVING 禁止下推HAVING表达式。 29 INLIST_TO_JOIN 控制使用inlist-to-join对SQL进行改写。 30 NO_INLIST_TO_JOIN 控制禁止使用inlist-to-join对SQL进行改写。 31 ROWNUM_PUSHDOWN 允许行号下推。 32 NO_ROWNUM_PUSHDOWN 禁止行号下推。 33 WINDOWAGG_PUSHDOWN 允许父查询中窗口函数的过滤条件下推到子查询。 34 NO_WINDOWAGG_PUSHDOWN 禁止父查询中窗口函数的过滤条件下推到子查询。 35 CS E_REWRITE_OPT 允许使用公共子表达式CSE查询重写将having公共子查询重写为窗口聚集函数。 36 NO_CSE_REWRITE_OPT 禁止使用公共子表达式CSE查询重写将having公共子查询重写为窗口聚集函数。 37 GROUPBY_PUSHDOWN_SUBQUERY 允许使用groupby-pushdown-subquery查询重写将groupby聚集函数下推到子查询。 38 NO_GROUPBY_PUSHDOWN_SUBQUERY 禁止使用groupby-pushdown-subquery查询重写将groupby聚集函数下推到子查询。

示例 强制使用Custom Plan： 1 2 3 4 set enable_fast_query_shipping = off; create table t (a int, b int, c int); prepare p as select /*+ use_cplan */ * from t where a = $1; explain execute p(1); 计划如下，可以看到过滤条件为入参的实际值，即此计划为Custom Plan。 强制使用Generic Plan： 1 2 3 deallocate p; prepare p as select /*+ use_gplan */ * from t where a = $1; explain execute p(1); 计划如下，可以看到过滤条件为待填充的入参，即此计划为Generic Plan。

DB_SYNONYMS DB_SYNONYMS视图显示当前用户可访问的所有同义词信息。 表1 DB_SYNONYMS字段 名称 类型 描述 owner text 同义词的所有者。PUBLIC同义词的所有者为PUBLIC。 schema_name text 同义词所属模式名。PUBLIC同义词的所属模式名NULL。 synonym_name text 同义词的名称。 table_owner text 关联对象的所有者。尽管该列称为table_owner，但它拥有的该关联对象不一定是表，可以是任何数据库通用对象，例如视图、存储过程、同义词等。 table_name text 关联对象名。尽管该列称为table_name，但此关联对象不一定是表，可以是任何数据库通用对象，例如视图、存储过程、同义词等。 table_schema_name text 关联对象所属模式名。尽管该列称为table_schema_name，但此schema下的该关联对象不一定是表，可以是任何数据库通用对象，例如视图、存储过程、同义词等。 db_link character varying(128) 保留字段，值为NULL。 origin_con_id character varying(256) 暂不支持，值为0。 父主题： 其他系统视图

基于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预处理以及编译执行 管理数据库连接 执行SQL命令 查询结果集 关闭数据库连接 宿主变量 执行动态SQL语句 错误处理 预处理指令 使用库函数 SQL描述符区域 常用示例 ecpg与Pro*C兼容性对比 ecpg接口参考 父主题： 应用程序开发教程

选择数据类型 在字段设计时，基于查询效率的考虑，一般需要遵循以下原则： 尽量使用高效数据类型。 选择数值类型时，在满足业务精度的情况下，选择数据类型的优先级从高到低依次为整数、浮点数、NUMERIC。 当多个表存在逻辑关系时，表示同一含义的字段应该使用相同的数据类型。 对于字符串数据，建议使用变长字符串数据类型，并指定最大长度。请务必确保指定的最大长度大于需要存储的最大字符数，避免出现超出字段定义最大长度的异常报错而导致业务中断现象。除非明确知道数据类型为固定长度字符串，否则，不建议使用CHAR(n)、BPCHAR(n)、NCHAR(n)、CHARACTER(n)。 关于字符串类型的详细说明，请参见常用字符串类型介绍。

PG_COMM_SEND_STREAM PG_COMM_SEND_STREAM视图展示单个DN上所有的通信库发送流状态。 表1 PG_COMM_SEND_STREAM字段 名称 类型 描述 node_name text 节点名称。 local_tid bigint 使用此通信流的线程ID。 remote_name text 连接对端节点名称。 remote_tid bigint 连接对端线程ID。 idx integer 通信对端DN在本DN内的标识编号。 sid integer 通信流在物理连接中的标识编号。 tcp_sock integer 通信流所使用的tcp通信socket。 state text 通信流当前的状态。 UNKNOWN：当前逻辑连接状态未知。 READY：逻辑连接已就绪。 RUN：逻辑连接发送报文正常。 HOLD：逻辑连接发送报文等待中。 CLOSED：关闭逻辑连接。 TO_CLOSED：将会关闭逻辑连接。 query_id bigint 通信流对应的debug_query_id编号。 pn_id integer 通信流所执行查询的plan_node_id编号。 send_smp integer 通信流所执行查询send端的smpid编号。 recv_smp integer 通信流所执行查询recv端的smpid编号。 send_bytes bigint 通信流发送的数据总量。单位：Byte。 time bigint 通信流当前生命周期使用时长。单位：ms。 speed bigint 通信流的平均发送速率。单位：Byte/s。 quota bigint 通信流当前的通信配额值。单位：Byte。 wait_quota bigint 通信流等待quota值产生的额外时间开销。单位：ms。 父主题： 通信

PG_STAT_BAD_BLOCK PG_STAT_BAD_BLOCK视图显示自节点启动后，读取数据时出现Page校验失败的统计信息。多租场景下，non-PDB访问该视图时返回全部信息，PDB访问该视图时仅返回该PDB相关信息。 表1 PG_STAT_BAD_BLOCK字段 名称 类型 描述 nodename text 节点名。 databaseid integer 数据库OID。 tablespaceid integer 表空间OID。 relfilenode integer 文件对象ID。 bucketid smallint 一致性hash bucket ID。 forknum integer 文件类型。取值如下： 0：数据主文件。 1：FSM文件。 2：VM文件。 3：BCM文件。 error_count integer 出现校验失败的次数。 first_time timestamp with time zone 第一次出现时间。 last_time timestamp with time zone 最后一次出现时间。 父主题： 其他系统视图

ADM_SEGMENTS ADM_SEGMENTS视图显示数据库中所有段分配的存储空间。同时存在于PG_CATA LOG 和SYS Schema下。仅系统管理员可访问。Astore支持段页式，但信息无法通过系统表获取。 表1 ADM_SEGMENTS字段 名称 类型 描述 owner character varying(128) 暂不支持，值为NULL。 segment_name character varying(128) 暂不支持，值为NULL。 partition_name character varying(128) 暂不支持，值为NULL。 segment_type character varying(18) 暂不支持，值为NULL。 segment_subtype character varying(10) 暂不支持，值为NULL。 tablespace_name character varying(30) 暂不支持，值为NULL。 header_file numeric 暂不支持，值为NULL。 header_block numeric 暂不支持，值为NULL。 bytes numeric 暂不支持，值为NULL。 blocks numeric 暂不支持，值为NULL。 extents numeric 暂不支持，值为NULL。 initial_extent numeric 暂不支持，值为NULL。 next_extent numeric 暂不支持，值为NULL。 min_extents numeric 暂不支持，值为NULL。 max_extents numeric 暂不支持，值为NULL。 max_size numeric 暂不支持，值为NULL。 retention character varying(7) 暂不支持，值为NULL。 minretention numeric 暂不支持，值为NULL。 pct_increase numeric 暂不支持，值为NULL。 freelists numeric 暂不支持，值为NULL。 freelist_groups numeric 暂不支持，值为NULL。 relative_fno numeric 暂不支持，值为NULL。 buffer_pool character varying(7) 暂不支持，值为NULL。 flash_cache character varying(7) 暂不支持，值为NULL。 cell_flash_cache character varying(7) 暂不支持，值为NULL。 inmemory character varying(8) 暂不支持，值为NULL。 inmemory_priority character varying(8) 暂不支持，值为NULL。 inmemory_distribute character varying(15) 暂不支持，值为NULL。 inmemory_duplicate character varying(13) 暂不支持，值为NULL。 inmemory_compression character varying(17) 暂不支持，值为NULL。 cellmemory character varying(24) 暂不支持，值为NULL。 父主题： 其他系统视图

常量与宏 GaussDB支持的常量和宏请参见表1。 表1 常量和宏 参数 描述 示例 CURRENT_CATALOG 当前数据库 1 2 3 4 5 testdb=# SELECT CURRENT_CATALOG; current_database ------------------ testdb (1 row) CURRENT_ROLE 当前用户 1 2 3 4 5 gaussdb=# SELECT CURRENT_ROLE; current_user -------------- omm (1 row) CURRENT_SCHEMA 当前数据库模式 1 2 3 4 5 gaussdb=# SELECT CURRENT_SCHEMA; current_schema ---------------- public (1 row) CURRENT_USER 当前用户 1 2 3 4 5 gaussdb=# SELECT CURRENT_USER; current_user -------------- omm (1 row) LOCALTIMESTAMP 当前会话时间（无时区） 1 2 3 4 5 gaussdb=# SELECT LOCALTIMESTAMP; timestamp ---------------------------- 2015-10-10 15:37:30.968538 (1 row) NULL 空值 - SESSION_USER 当前系统用户 1 2 3 4 5 gaussdb=# SELECT SESSION_USER; session_user -------------- omm (1 row) SYSDATE 当前系统日期 1 2 3 4 5 gaussdb=# SELECT SYSDATE; sysdate --------------------- 2015-10-10 15:48:53 (1 row) USER 当前用户，此用户为CURRENT_USER的别名。 1 2 3 4 5 gaussdb=# SELECT USER; current_user -------------- omm (1 row) 父主题： SQL参考

GS_TOTAL_MEMORY_DETAIL GS_TOTAL_MEMORY_DETAIL视图显示当前数据库节点的内存使用情况，单位为MB。当GUC参数enable_memory_limit的值为off时，本视图不可用。在多租场景下，在PDB下返回空。 表1 GS_TOTAL_MEMORY_DETAIL字段 名称 类型 描述 nodename text 节点名称。 memorytype text 内存类型，包括以下几种： max_process_memory：GaussDB实例所占用的内存大小。 process_used_memory：GaussDB进程所使用的内存大小。 max_dynamic_memory：最大动态内存。 dynamic_used_memory：已使用的动态内存。 dynamic_peak_memory：内存的动态峰值。 dynamic_used_shrctx：最大动态共享内存上下文。 dynamic_peak_shrctx：共享内存上下文的动态峰值。 max_backend_memory：使用HA端口执行业务可使用的最大内存上限。 backend_used_memory：使用HA端口执行业务已使用的内存。 max_shared_memory：最大共享内存。 shared_used_memory：已使用的共享内存。 max_sctpcomm_memory：通信库所允许使用的最大内存。 sctpcomm_used_memory：通信库已使用的内存大小。 sctpcomm_peak_memory：通信库的内存峰值。 other_used_memory：其他已使用的内存大小。 llvm_used_memory：当前系统中 Codegen 执行生成的且查询未释放的表达式 IR 所占用内存大小。 memorymbytes integer 内存类型分配内存的大小。 父主题： 其他系统视图

GS_STATIC_THREADPOOL_CTRL_STATUS GS_STATIC_THREADPOOL_CTRL_STATUS返回当前实例线程池相关静态线程的统计信息。线程池开启状态下，CN线程池支持该视图查询。连接DN查询返回空行；线程池关闭下返回空行；参数static_thread_pool_num设置为0或小于线程池group数时静态线程池默认值为0。查询该视图需要PUBLIC权限。 表1 GS_STATIC_THREADPOOL_CTRL_STATUS字段 名称 类型 描述 node_name text 实例名。 group_id integer 线程池group组id。 worker_info text 描述当前group组线程池运行中的动态的统计信息。包括如下信息： default、default_s：线程数量。动态线程池默认值，静态线程池默认值。 expect、expect_s：线程数量。动态线程池预期值，静态线程池预期值。 actual：实际运行的线程数量，包括动态池线程和静态池线程。 static threads limit：当前group组配置的静态池线程数。 has static threads：当前group组是否创建静态池。默认为0，表示没有创建。 idle static threads：空闲的静态池线程个数。 wait session num：等待的会话数。 父主题： 通信

LOCAL_ACTIVE_SESSION LOCAL_ACTIVE_SESSION视图显示本节点上的ACTIVE SESSION PROFILE内存中的样本，如表1所示。 表1 LOCAL_ACTIVE_SESSION字段 名称 类型 描述 sampleid bigint 采样ID。 sample_time timestamp with time zone 采样的时间。 need_flush_sample boolean 该样本是否需要刷新到磁盘。 databaseid oid 数据库ID thread_id bigint 线程的ID。 sessionid bigint 会话的ID。 start_time timestamp with time zone 会话的启动时间。 event text 具体的事件名称。 lwtid integer 当前线程的轻量级线程号。 psessionid bigint streaming线程的父线程。 tlevel integer streaming线程的层级。与执行计划的层级（id）相对应。 smpid integer smp执行模式下并行线程的并行编号。 userid oid session用户的id。 application_name text 应用的名称。 client_addr inet client端的地址。 client_hostname text client端的名称。 client_port integer 客户端用于与后端通讯的TCP端口号。 query_id bigint debug query id。 unique_query_id bigint unique query id。 user_id oid unique query的key中的user_id。 cn_id integer cn id，在DN上表示下发该unique sql的节点id，unique query的key中的cn_id。 unique_query text 规范化后的UniqueSQL文本串。 locktag text 会话等待锁信息，可通过locktag_decode解析。 lockmode text 会话等待锁模式。 block_sessionid bigint 如果会话正在等待锁，阻塞该会话获取锁的会话标识。 final_block_sessionid bigint 表示源头阻塞会话id。 wait_status text 描述event列的更多详细信息。 global_sessionid text 全局会话ID xact_start_time timestamp with time zone 事务开始时间。 query_start_time timestamp with time zone 语句开始执行时间。 state text 当前语句状态。 可能取值为：active、dle in transaction、fastpath function call、idle in transaction (aborted)、disabled、retrying。 event_start_time timestamp with time zone wait event的开始时间。 current_xid xid 当前事务ID。 top_xid xid 顶层事务ID。 parent_unique_sql_id bigint 调用本条语句的父语句SQL_Id。 父主题： Session/Thread

运维管理员 运维管理员是指具有OPRADMIN属性的账户，具有使用Roach工具执行备份恢复的权限。 要创建新的运维管理员，请以初始用户身份连接数据库，并使用带OPRADMIN选项的CREATE USER语句或 ALTER USER语句进行设置。 1 gaussdb=# CREATE USER opradmin WITH OPRADMIN password "********"; 或者 1 gaussdb=# ALTER USER joe OPRADMIN; ALTER USER时，要求用户已存在。

安全策略管理员 安全策略管理员是指具有POLADMIN属性的账户，具有创建资源标签、脱敏策略和统一审计策略的权限。 要创建新的安全策略管理员，请以系统管理员用户身份连接数据库，并使用带POLADMIN选项的CREATE USER语句或 ALTER USER语句进行设置。 1 gaussdb=# CREATE USER poladmin WITH POLADMIN password "********"; 或者 1 gaussdb=# ALTER USER joe POLADMIN; ALTER USER时，要求用户已存在。

审计管理员 审计管理员是指具有AUDITADMIN属性的账户，具有查看和删除审计日志的权限。 要创建新的审计管理员，三权分立关闭时，请以系统管理员或者安全管理员身份连接数据库。三权分立打开时，只能以初始用户身份连接数据库，并使用带AUDITADMIN选项的CREATE USER语句或 ALTER USER语句进行设置。 1 gaussdb=# CREATE USER auditadmin WITH AUDITADMIN password "********"; 或者 1 gaussdb=# ALTER USER joe AUDITADMIN; ALTER USER时，要求用户已存在。

安全管理员 安全管理员是指具有CREATEROLE属性的账户，具有创建、修改、删除用户或角色的权限，和授予或者撤销任何非系统管理员、内置角色、永久用户、运维管理员的权限。 要创建新的安全管理员，三权分立关闭时，请以系统管理员或者安全管理员身份连接数据库。三权分立打开时，请以安全管理员身份连接数据库，并使用带CREATEROLE选项的CREATE USER语句或 ALTER USER语句进行设置。 1 gaussdb=# CREATE USER createrole WITH CREATEROLE password "********"; 或者 1 gaussdb=# ALTER USER joe CREATEROLE; ALTER USER时，要求用户已存在。

监控管理员 监控管理员是指具有MONADMIN属性的账户，具有查看dbe_perf模式下视图和函数的权限，亦可以对dbe_perf模式的对象权限进行授予或收回。 要创建新的监控管理员，请以系统管理员身份连接数据库，并使用带MONADMIN选项的CREATE USER语句或 ALTER USER语句进行设置。 1 gaussdb=# CREATE USER monadmin WITH MONADMIN password "********"; 或者 1 gaussdb=# ALTER USER joe MONADMIN; ALTER USER时，要求用户已存在。

初始用户 集群安装过程中自动生成的账户称为初始用户。初始用户也是系统管理员、安全管理员、审计管理员、监控管理员、运维管理员和安全策略管理员，拥有系统的最高权限，能够执行所有的操作。如果安装时不设置初始用户名称，则该账户与进行集群安装的操作系统用户同名。如果在安装集群时不设置初始用户的密码，安装完成后密码为空，在执行其他操作前需要通过gsql客户端修改初始用户的密码。如果初始用户密码为空，则除修改密码外，无法执行其他SQL操作以及升级、扩容、节点替换等操作。 初始用户的oid为10，可以通过gs_roles视图查询。 初始用户会绕过所有权限检查。建议仅将初始用户作为DBA管理用途，而非业务应用。

系统管理员 系统管理员是指具有SYSADMIN属性的账户，默认安装情况下具有与对象所有者相同的权限，但不包括dbe_perf模式的对象权限。 要创建新的系统管理员，请以初始用户或者系统管理员用户身份连接数据库，并使用带SYSADMIN选项的CREATE USER语句或ALTER USER语句进行设置。 1 gaussdb=# CREATE USER sysadmin WITH SYSADMIN password "********"; 或者 1 gaussdb=# ALTER USER joe SYSADMIN; ALTER USER时，要求用户已存在。

ecpg预处理以及编译执行 准备嵌入式SQL-C源程序，以.pgc为后缀名，ecpg负责将其转换成可被编译器编译的C语言程序。 生成的C语言程序被gcc编译器编译为可执行文件，运行该可执行文件实现客户端程序访问数据库。示例请参见常用示例章节。 ecpg预处理以及编译处理过程 预处理：ecpg -I $GAUSSHOME/include -o test.c test.pgc ecpg预处理的参数选项如下： ecpg [OPTION]... 其中OPTION参数选项如下： -o OUTFILE：预处理嵌入式SQL-C程序将结果写入OUTFILE，OUTFILE为C语言文件。 -I DIRECTORY：头文件的搜索路径。 -c：预处理嵌入式SQL-C程序自动生成C语言文件。 --version：查看ecpg当前版本。 -C MODE：指定预处理兼容模式，“ORA”为O兼容。 编译：gcc -I $GAUSSHOME/include/ecpg -I $GAUSSHOME/include -I $GAUSSHOME/include/gaussdb/server/ -L $GAUSSHOME/lib -lecpg -lrt -lpq -lpgtypes -lpthread test_ecpg.c -o test_ecpg 执行：./test ecpg作为编译预处理工具，若在预处理或编译过程中出现找不到头文件或者函数实现的报错信息，可以根据需要指定头文件，或者链接动态库。 ecpg需要gcc、ld等编译预处理工具，建议gcc使用7.3.0版本。 使用ecpg开发应用程序所依赖的其他动态库和头文件，常见的位于$GAUSSHOME/include/libpq, $GAUSSHOME/include。 编译过程中常见的动态库依赖：-lpq、-lpq_ce、-lpthread。若开发过程中需要使用libpq通信库，则需要连接-lpq和-lpq_ce。若开发过程中需要使用多线程连接，则需要连接-lpthread。 父主题： 基于ecpg开发

GS_LOGICAL_CONSTRAINT GS_LOGICAL_CONSTRAINT系统表记录逻辑解码需要使用的表上的检查约束、主键和唯一约束。 表1 GS_LOGICAL_CONSTRAINT字段 名称 类型 描述 conname name 约束名称（不一定是唯一的）。 connamespace oid 包含这个约束的名称空间的OID。 contype "char" c：检查约束。 p：主键约束。 u：唯一约束。 t：触发器约束。 x：互斥约束。 f：外键约束。 s：聚簇约束。 i：无效约束。 condeferrable boolean 这个约束是否可以推迟。 true：表示可以。 false：表示不可以。 condeferred boolean 缺省时这个约束是否可以推迟。 true：表示可以。 false：表示不可以。 convalidated boolean 约束是否有效。目前，只有外键和CHECK约束可将其设置为false。 true：表示有效。 false：表示无效。 conrelid oid 这个约束所在的表，如果不是表约束则为0。 contypid oid 这个约束所在的域，如果不是一个域约束则为0。 conindid oid 与约束关联的索引ID。 confrelid oid 如果是外键，则为参考的表，否则为0。 confupdtype "char" 外键更新动作代码。 a：没动作。 r：限制。 c：级联。 n：设置为null。 d：设置为缺省。 confdeltype "char" 外键删除动作代码。 a：没动作。 r：限制。 c：级联。 n：设置为null。 d：设置为缺省。 confmatchtype "char" 外键匹配类型。 f：全部。 p：部分。 u：未指定（在f的基础上允许匹配NULL值）。 conislocal boolean 是否是为关系创建的本地约束。 true：表示是。 false：表示不是。 coninhcount integer 约束直接继承父表的数目。继承父表数非零时，不能删除或重命名该约束。 connoinherit boolean 是否可以被继承。 true：表示可以。 false：表示不可以。 consoft boolean 是否为信息约束(Informational Constraint)。 true：表示是。 false：表示不是。 conopt boolean 是否使用信息约束优化执行计划。 true：表示使用。 false：表示不使用。 csnmin bigint 插入元组时的CSN（提交序列号）。 csnmax bigint 更新或删除元组时的CSN。 createtime timestamp with time zone 插入元组的时间戳。 originid integer 元组的来源标识符。 dbnode oid 数据库OID。 constroid oid 行标识符。 conkey smallint[] 如果是表约束，则是约束控制的字段列表。 confkey smallint[] 如果是一个外键，是参考的字段的列表。 conpfeqop oid[] 如果是一个外键，是做PK=FK比较的相等操作符ID的列表。 conppeqop oid[] 如果是一个外键，是做PK=PK比较的相等操作符ID的列表。 conffeqop oid[] 如果是一个外键，是做FK=FK比较的相等操作符ID的列表。 conexclop oid[] 如果是一个排他约束，是列的排他操作符ID列表。 consrc text 如果是检查约束，则是表达式的可读形式。 conincluding smallint[] 不用做约束，但是会包含在INDEX中的属性列。 父主题： 逻辑解码

声明段 要实现嵌入式SQL-C程序和数据库间的数据交互（例如：从SQL-C程序把查询语句中的参数传递给数据库，或者从数据库向嵌入式SQL-C程序传回数据），需要在特殊的标记段里面声明包含此数据的C语言变量，以便预处理器能够识别。 标记段以下面的代码开始： EXEC SQL BEGIN DECLARE SECTION; 以下面的代码结束： EXEC SQL END DECLARE SECTION; 在此之间，必须有常规的C语言变量声明，比如： int x = 4; char foo[16], bar[16]; 标记段代码开始和结束之间声明的宿主变量类型必须为当前支持的数据类型，请参见表1。 可以隐式地创建一个声明段声明变量：EXEC SQL int i = 4。 不在SQL命令里使用的变量可以在特殊的声明段外面声明。 结构体或者联合体的定义也必须在DECLARE段中列出，否则预处理器就无法处理这些类型。 父主题： 宿主变量

STATIO_ALL_INDEXES STATIO_ALL_INDEXES视图包含数据库中的每个索引行，显示特定索引的I/O的统计，如表1所示。 表1 STATIO_ALL_INDEXES字段 名称 类型 描述 relid oid 索引的表的OID。 indexrelid oid 该索引的OID。 schemaname name 该索引的模式名。 relname name 该索引的表名。 indexrelname name 索引名称。 idx_blks_read bigint 从索引中读取的磁盘块数。 idx_blks_hit bigint 索引命中缓存数。 last_updated timestamp with time zone 视图中该对象监控数据最后一次更新的时间。 父主题： Cache/IO

返回值 ConnStatusType：连接状态的枚举，包括： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 CONNECTION_STARTED 等待进行连接。 CONNECTION_MADE 连接成功；等待发送。 CONNECTION_AWAITING_RESPONSE 等待来自服务器的响应。 CONNECTION_AUTH_OK 已收到认证；等待后端启动结束。 CONNECTION_SSL_STARTUP 协商SSL加密。 CONNECTION_SETENV 协商环境驱动的参数设置。 CONNECTION_OK 连接正常。 CONNECTION_BAD 连接故障。

注意事项 状态可以是多个值之一。但是，在异步连接过程之外只能看到其中两个：CONNECTION_OK和CONNECTION_BAD。与数据库的良好连接状态为CONNECTION_OK，与数据库连接失败状态为CONNECTION_BAD。通常，“正常”状态将一直保持到PQfinish，但通信失败可能会导致状态过早变为CONNECTION_BAD。在这种情况下，应用程序可以尝试通过调用进行恢复PQreset。

SQL Statistics SQL Statistics列名称及描述如表1所示。 表1 SQL Statistics报表主要内容 列名称 描述 Unique SQL Id 归一化的SQL id。 DB Name 数据库名称。 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）。 Lock Wait Time(us) SQL语句的等锁时间（us）。 Avg Lock Wait Time(us) 平均每条SQL语句的等锁时间（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报告信息介绍

简单查询 简单查询指从一个或多个表或视图中检索一个或多个列数据的操作。 --建表并插入数据。 gaussdb=# CREATE TABLE student( sid INT PRIMARY KEY, class INT, name VARCHAR(50), sex INT CHECK(sex = 0 OR sex = 1) --性别，1为男，0为女 ); gaussdb=# INSERT INTO student (sid, class, name, sex) VALUES (1, 1, 'Michael', 0); gaussdb=# INSERT INTO student (sid, class, name, sex) VALUES (2, 2, 'Bob', 1); gaussdb=# INSERT INTO student (sid, class, name, sex) VALUES (3, 2, 'Gary', 0); --查询部分列。 gaussdb=# SELECT sid, name FROM student; sid | name -----+--------- 1 | michael 2 | bob 3 | Gary (3 rows) --查询所有列。 gaussdb=# SELECT * FROM student; sid | class | name | sex -----+-------+---------+----- 1 | 1 | michael | 0 2 | 2 | bob | 1 3 | 2 | Gary | 0 (3 rows) --给列取别名。 gaussdb=# SELECT sid student_id, name FROM student; student_id | name ------------+--------- 1 | michael 2 | bob 3 | Gary (3 rows) --删除。 gaussdb=# DROP TABLE student; 父主题： SELECT

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对应的线程创建的时间。 dbid oid 线程所属的数据库id。 父主题： OS

参数说明 direction 定义抓取数据的方向。 取值范围： NEXT（缺省值） 从当前关联位置开始，抓取下一行。 PRIOR 从当前关联位置开始，抓取上一行。 FIRST 抓取查询的第一行（和ABSOLUTE 1相同）。 LAST 抓取查询的最后一行（和ABSOLUTE -1相同）。 ABSOLUTE count 抓取查询中第count行。 ABSOLUTE抓取不会比用相对位移移动到需要的数据行更快，因为下层的实现必须遍历所有中间的行。 count取值范围：有符号的整数 count为正数，就从查询结果的第一行开始，抓取第count行。当count小于当前游标位置时，涉及到rewind操作，暂不支持。 count为负数或0，涉及到反向扫描操作，暂不支持。 RELATIVE count 从当前关联位置开始，抓取随后或前面的第count行。 取值范围：有符号的整数 count为正数就抓取当前关联位置之后的第count行。 count为负数或0，涉及到反向扫描操作，暂不支持。 如果当前行没有数据的话，RELATIVE 0返回空。 count 抓取随后的count行（和FORWARD count一样）。 ALL 从当前关联位置开始，抓取所有剩余的行（和FORWARD ALL一样）。 FORWARD 抓取下一行（和NEXT一样）。 FORWARD count 与RELATIVE count的效果相同，从当前关联位置开始，抓取随后或前面的第count行。 FORWARD ALL 从当前关联位置开始，抓取所有剩余行。 BACKWARD 从当前关联位置开始，抓取前面一行(和PRIOR一样) 。 BACKWARD count 从当前关联位置开始，抓取前面的count行（向后扫描）。 取值范围：有符号的整数 count为正数就抓取当前关联位置之前的第count行。 count为负数就抓取当前关联位置之后的第abs（count）行。 如果有数据的话，BACKWARD 0重新抓取当前行。 BACKWARD ALL 从当前关联位置开始，抓取所有前面的行（向后扫描） 。 { FROM | IN } cursor_name 使用关键字FROM或IN指定游标名称。 取值范围：已创建的游标的名称。