华为云用户手册

MY_COL_COMMENTS MY_COL_COMMENTS视图显示当前用户下表的列注释信息。该视图同时存在于PG_CATA LOG 和SYS Schema下。具体字段信息如表1所示。 表1 MY_COL_COMMENTS字段 名称 类型 描述 owner character varying(128) 表的所有者。 table_name character varying(128) 表的名称。 column_name character varying(128) 列名称。 comments text 注释。 origin_con_id numeric 暂不支持，值为0。 schema character varying(64) 列所属的名称空间的名称。 父主题： 其他系统视图

GS_MY_PLAN_TRACE GS_MY_PLAN_TRACE是系统表GS_PLAN_TRACE的视图，该视图主要用来查看当前用户的plan trace。具体字段信息如表1所示。分布式场景下不支持plan trace特性，所以在分布式下该视图中无数据。 表1 GS_MY_PLAN_TRACE字段 名称 类型 描述 query_id text 当前请求的唯一id。 query text 当前请求的sql语句，该字段大小不会超过系统参数track_activity_query_size指定的大小。 unique_sql_id bigint 当前请求sql的唯一id。 plan text 当前请求sql对应的查询计划文本。该字段大小不会超过10K。 plan_trace text 当前请求sql对应的查询计划生成过程的明细，该字段大小不会超过300M。 modifydate timestamp with time zone 当前plan trace的更新时间（当前指的是plan trace创建时间）。 父主题： 其他系统视图

DB_TAB_COL_STATIS TICS DB_TAB_COL_STATISTI CS 视图显示从DB_TAB_COLUMNS中提取的列统计信息和直方图信息。所有用户都可以访问该视图。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 DB_TAB_COL_STATISTICS字段 名称 类型 描述 owner character varying(128) 表的所有者。 table_name character varying(128) 表名。 column_name character varying(128) 列名。 num_distinct numeric 列中不同值的数量。 low_value raw 列中的低值。 high_value raw 列中的高值。 density numeric 如果COLUMN_NAME上有直方图，则此列将显示直方图中跨越少于2个端点的值的选择性。它不代表跨越2个或更多端点的值的选择性。 如果COLUMN_NAME上没有可用的直方图，则该列的值为1/NUM_DISTINCT。 num_nulls numeric 列中空值数。 num_buckets numeric 列的直方图中的桶数。 sample_size numeric 用于分析此列的样本量。 last_analyzed timestamp(0) without time zone 最近分析此列的日期。数据库重启后，数据会丢失。 global_stats character varying(3) 暂不支持，值为NULL。 user_stats character varying(3) 暂不支持，值为NULL。 notes character varying(99) 暂不支持，值为NULL。 avg_col_len numeric 列的平均长度（以字节为单位）。 histogram character varying(15) 直方图是否存在以及其类型： NONE：不存在直方图。 FREQUENCY：频率直方图。 EQUI-W IDT H：等宽直方图。 scope character varying(7) 对于在除全局临时表之外的任何表上收集的统计信息，该值是SHARED（表示统计信息在所有会话之间共享）。 schema character varying(64) 列所属的名称空间的名称。 父主题： 其他系统视图

DB_SEQUEN CES DB_SEQUENCES视图显示当前用户能够访问的所有序列的信息。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 DB_SEQUENCES字段 名称 类型 描述 sequence_owner name 序列所有者。 sequence_name name 序列的名称。 min_value int16 序列最小值。 max_value int16 序列最大值。 increment_by int16 序列的增量。 cycle_flag character(1) 序列是否是循环序列。取值范围： Y表示是循环序列。 N表示不是循环序列。 order_flag character varying(1) 标志序列是否按照请求顺序发生。暂不支持，值为NULL。 cache_size int16 序列磁盘缓存大小。 last_number int16 该序列从GTM中一次性批量申请的最后一个值。 scale_flag character varying(1) 标志是否为可扩展序列。暂不支持，值为NULL。 extend_flag character varying(1) 标志可扩展序列生成的值是否超出序列最大值、最小值范围。暂不支持，值为NULL。 sharded_flag character varying(1) 标志是否为分片序列。暂不支持，值为NULL。 session_flag character varying(1) 标志序列是否为私有会话。暂不支持，值为NULL。 keep_value character varying(1) 标志在失败后的replay期间是否保留序列值。暂不支持，值为NULL。 父主题： 其他系统视图

DB_INDEXES DB_INDEXES视图显示当前用户可访问的索引信息。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 DB_INDEXES字段 名称 类型 描述 owner character varying(64) 索引的所有者。 index_name character varying(64) 索引名称。 table_name character varying(64) 索引对应的表名。 uniqueness text 该索引是否为唯一索引。 UNIQUE：唯一索引。 NONUNIQUE：非唯一索引。 partitioned character(3) 该索引是否具有分区表的性质。 Yes：索引具有分区表的性质。 No：索引不具有分区表的性质。 generated character varying(1) 该索引的名称是否为系统生成。 y：索引名称为系统生成。 n：索引名称非系统生成。 index_type character varying(27) 索引类型。 NORMAL：索引属性都是简单的引用，表达式树为空。 FUNCTION-BASED NORMAL：存在表达式树用于非简单字段引用的索引属性。 table_owner character varying(128) 索引对象的所有者。 table_type character(11) 索引对象的类型。 TABLE：索引对象为表类型。 tablespace_name character varying(30) 包含索引的表空间名称。 status character varying(8) 非分区索引状态。 VALID：非分区索引可以用于查询。 UNUSABLE：非分区索引不可用。 N/A：索引具有分区表性质。 compression character varying(13) 暂不支持，值为NULL。 prefix_length numeric 暂不支持，值为NULL。 ini_trans numeric 暂不支持，值为NULL。 max_trans numeric 暂不支持，值为NULL。 initial_extent numeric 暂不支持，值为NULL。 next_extent numeric 暂不支持，值为NULL。 min_extents numeric 暂不支持，值为NULL。 max_extents numeric 暂不支持，值为NULL。 pct_increase numeric 暂不支持，值为NULL。 pct_threshold numeric 暂不支持，值为NULL。 include_column numeric 暂不支持，值为NULL。 freelists numeric 暂不支持，值为NULL。 freelist_groups numeric 暂不支持，值为NULL。 pct_free numeric 暂不支持，值为NULL。 logging character varying(3) 暂不支持，值为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。 degree character varying(40) 暂不支持，值为NULL。 instances character varying(40) 暂不支持，值为NULL。 temporary character varying(1) 暂不支持，值为NULL。 secondary character varying(1) 暂不支持，值为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。 duration character varying(15) 暂不支持，值为NULL。 pct_direct_access numeric 暂不支持，值为NULL。 ityp_owner character varying(128) 暂不支持，值为NULL。 ityp_name character varying(128) 暂不支持，值为NULL。 parameters character varying(1000) 暂不支持，值为NULL。 global_stats character varying(3) 暂不支持，值为NULL。 domidx_status character varying(12) 暂不支持，值为NULL。 domidx_opstatus character varying(6) 暂不支持，值为NULL。 funcidx_status character varying(8) 暂不支持，值为NULL。 join_index character varying(3) 暂不支持，值为NULL。 iot_redundant_pkey_elim character varying(3) 暂不支持，值为NULL。 dropped character varying(3) 暂不支持，值为NULL。 visibility character varying(9) 该索引对优化器是否可见。 VISIBLE：索引对优化器可见。 INVISIBLE：索引对优化器不可见。 domidx_management character varying(14) 暂不支持，值为NULL。 segment_created character varying(3) 暂不支持，值为NULL。 orphaned_entries character varying(3) 暂不支持，值为NULL。 indexing character varying(7) 暂不支持，值为NULL。 auto character varying(3) 暂不支持，值为NULL。 父主题： 其他系统视图

ADM_TAB_STATISTICS ADM_TAB_STATISTICS显示数据库中所有表的优化程序统计信息。该视图同时存在于PG_CATALOG和SYS Schema下。默认只有系统管理员权限才可以访问，普通用户需要授权才可以访问。 表1 ADM_TAB_STATISTICS字段 名称 类型 描述 owner character varying(128) 对象的所有者。 table_name character varying(128) 表名。 partition_name character varying(128) 暂不支持，值为NULL。 partition_position numeric 暂不支持，值为NULL。 subpartition_name character varying(128) 暂不支持，值为NULL。 subpartition_position numeric 暂不支持，值为NULL。 object_type character varying(12) 对象类型： TABLE PARTITION SUBPARTITION num_rows numeric 对象中的行数。 blocks numeric 暂不支持，值为NULL。 empty_blocks numeric 暂不支持，值为NULL。 avg_space numeric 暂不支持，值为NULL。 chain_cnt numeric 暂不支持，值为NULL。 avg_row_len integer 平均行长，包括行开销。 avg_space_freelist_blocks numeric 暂不支持，值为NULL。 num_freelist_blocks numeric 暂不支持，值为NULL。 avg_cached_blocks numeric 暂不支持，值为NULL。 avg_cache_hit_ratio numeric 暂不支持，值为NULL。 im_imcu_count numeric 暂不支持，值为NULL。 im_block_count numeric 暂不支持，值为NULL。 im_stat_update_time timestamp(6) without time zone 暂不支持，值为NULL。 scan_rate numeric 暂不支持，值为NULL。 sample_size numeric 分析表格时使用的样本量。 last_analyzed timestamp with time zone 最近分析表的日期。数据库重启后，数据会丢失。 global_stats character varying(3) 暂不支持，值为NULL。 user_stats character varying(3) 暂不支持，值为NULL。 stattype_locked character varying(5) 暂不支持，值为NULL。 stale_stats character varying(7) 暂不支持，值为NULL。 notes character varying(25) 暂不支持，值为NULL。 scope character varying(7) 暂不支持，默认值SHARED。 父主题： 其他系统视图

ADM_TAB_COLUMNS ADM_TAB_COLUMNS视图显示关于表和视图的字段的信息。数据库中每个表和视图的每一个字段在ADM_TAB_COLUMNS里各有一行对应的数据。默认只有系统管理员权限才可以访问，普通用户需要授权才可以访问。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 ADM_TAB_COLUMNS字段 名称 类型 描述 owner character varying(64) 表的所有者。 table_name character varying(64) 表的名称。 column_name character varying(64) 列名。 data_type character varying(128) 列的数据类型。 data_type_mod character varying(3) 暂不支持，值为NULL。 data_type_owner character varying(128) 列的数据类型的所有者。 data_length integer 列的字节长度。 data_precision integer 数据类型的精度。对于numeric数据类型有效，其他类型为NULL。 data_scale integer 小数点右边的位数。对于numeric数据类型有效，其他类型为0。 nullable bpchar 该列是否允许为空。取值范围： y：允许。 n：不允许。对于主键约束和非空约束，该值为n。 column_id integer 创建表时列的序号。 default_length numeric 列的默认值字节长度，无默认值时为空。 data_default text 列的默认值。 num_distinct numeric 列中不同值的数量。 low_value raw 列中的最小值。 high_value raw 列中的最大值。 density numeric 列密度。 num_nulls numeric 列中空值数。 num_buckets numeric 列的直方图的桶数。 last_analyzed date 上次分析的日期。 sample_size numeric 用于分析此列的样本量。 character_set_name character varying(44) 暂不支持，值为NULL。 char_col_decl_length numeric 字符类型列的声明长度。 global_stats character varying(3) 暂不支持，值为NO。 user_stats character varying(3) 暂不支持，值为NO。 avg_col_len numeric 列的平均长度（单位字节）。 char_length numeric 列的长度（以字符计）。只对varchar，nvarchar2，bpchar，char类型有效。 char_used character varying(1) 暂不支持。 B：varchar、bpchar与char类型。 C：nvarchar2类型。 NULL：其余类型。 v80_fmt_image character varying(3) 暂不支持，值为NULL。 data_upgraded character varying(3) 暂不支持，值为YES。 histogram character varying(15) 直方图是否存在以及存在的类型： NONE：不存在直方图。 FREQUENCY：频率直方图。 EQUI_WIDTH：等宽直方图。 default_on_null character varying(3) 暂不支持，值为NULL。 identity_column character varying(3) 暂不支持，值为NULL。 sensitive_column character varying(3) 暂不支持，值为NULL。 evaluation_edition character varying(128) 暂不支持，值为NULL。 unusable_before character varying(128) 暂不支持，值为NULL。 unusable_beginning character varying(128) 暂不支持，值为NULL。 collation character varying(100) 列的排序规则。因该字段与保留关键字冲突，调用该字段需加视图名。 comments text 列的注释。 schema character varying(64) 列所属的名称空间的名称。 父主题： 其他系统视图

ADM_SOURCE ADM_SOURCE视图显示数据库中所有存储过程、函数、触发器的定义信息。默认只有系统管理员权限才可以访问，普通用户需要授权才可以访问。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 ADM_SOURCE字段 名称 类型 描述 owner name 对象的所有者。 name name 对象的名字。 type name 对象的类型。取值范围：function、procedure、trigger。 line numeric 此行在定义信息中的行号。 text text 存储对象的文本来源。 origin_con_id character varying(256) 暂不支持，值为0。 父主题： 其他系统视图

ADM_SEGMENTS ADM_SEGMENTS视图显示数据库中所有段分配的存储空间。同时存在于PG_CATALOG和SYS Schema下。仅系统管理员可访问。信息无法通过系统表获取。该视图为空视图。 表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。 父主题： 其他系统视图

PG_RUNNING_XA CTS PG_RUNNING_XACTS视图显示当前节点运行事务的信息。具体字段信息如表1所示。 表1 PG_RUNNING_XACTS字段 名称 类型 描述 handle integer 事务在GTM对应的句柄。 gxid xid 事务id号。 state tinyint 事务状态。 3：prepared。 0：starting。 node text 节点名称。 xmin xid 节点上当前数据涉及的最小事务号。 vacuum boolean 表示当前事务是否是lazy vacuum事务。 t（true）：表示是。 f（false）：表示不是。 timeline bigint 数据库重启次数。 prepare_xid xid 处于prepared状态的事务的id，若事务不在prepared状态，值为0。 pid bigint 事务对应的线程id。 next_xid xid CN传给DN的事务id。 dbid oid 事务对应的数据库id。 父主题： 其他系统视图

NLS_INSTANCE_PA RAM ETERS NLS_INSTANCE_PARAMETERS列出数据库客户端的永久NLS参数。该视图同时存在于PG_CATALOG和SYS Schema下。所有用户都可以访问。由于数据库内核不同、参数的设置格式不同等原因，该视图对相同参数的查询结果中可能会和ORA数据库有明显差异。具体字段信息如表1所示。 表1 NLS_INSTANCE_PARAMETERS字段 名称 类型 描述 parameter character varying(128) 参数名。 value character varying(64) 参数值。 父主题： 其他系统视图

示例 创建示例表和索引： create table t1(c1 int, c2 int, c3 int);create table t2(c1 int, c2 int, c3 int);create table t3(c1 int, c2 int, c3 int);create index it1 on t1(c1,c2);create index it2 on t2(c1,c2);create index it3 on t1(c3,c2);-- 下面TPCH数据表需要插入10X数据量已匹配给出的计划示例create table store( s_store_sk integer not null, s_store_id char(16) not null, s_rec_start_date date , s_rec_end_date date , s_closed_date_sk integer , s_store_name varchar(50) , s_number_employees integer , s_floor_space integer , s_hours char(20) , s_manager varchar(40) , s_market_id integer , s_geography_class varchar(100) , s_market_desc varchar(100) , s_market_manager varchar(40) , s_division_id integer , s_division_name varchar(50) , s_company_id integer , s_company_name varchar(50) , s_street_number varchar(10) , s_street_name varchar(60) , s_street_type char(15) , s_suite_number char(10) , s_city varchar(60) , s_county varchar(30) , s_state char(2) , s_zip char(10) , s_country varchar(20) , s_gmt_offset decimal(5,2) , s_tax_precentage decimal(5,2) , primary key (s_store_sk));create table store_sales( ss_sold_date_sk integer , ss_sold_time_sk integer , ss_item_sk integer not null, ss_customer_sk integer , ss_cdemo_sk integer , ss_hdemo_sk integer , ss_addr_sk integer , ss_store_sk integer , ss_promo_sk integer , ss_ticket_number integer not null, ss_quantity integer , ss_wholesale_cost decimal(7,2) , ss_list_price decimal(7,2) , ss_sales_price decimal(7,2) , ss_ext_discount_amt decimal(7,2) , ss_ext_sales_price decimal(7,2) , ss_ext_wholesale_cost decimal(7,2) , ss_ext_list_price decimal(7,2) , ss_ext_tax decimal(7,2) , ss_coupon_amt decimal(7,2) , ss_net_paid decimal(7,2) , ss_net_paid_inc_tax decimal(7,2) , ss_net_profit decimal(7,2) , primary key (ss_item_sk, ss_ticket_number));create table store_returns( sr_returned_date_sk integer , sr_return_time_sk integer , sr_item_sk integer not null, sr_customer_sk integer , sr_cdemo_sk integer , sr_hdemo_sk integer , sr_addr_sk integer , sr_store_sk integer , sr_reason_sk integer , sr_ticket_number integer not null, sr_return_quantity integer , sr_return_amt decimal(7,2) , sr_return_tax decimal(7,2) , sr_return_amt_inc_tax decimal(7,2) , sr_fee decimal(7,2) , sr_return_ship_cost decimal(7,2) , sr_refunded_cash decimal(7,2) , sr_reversed_charge decimal(7,2) , sr_store_credit decimal(7,2) , sr_net_loss decimal(7,2) , primary key (sr_item_sk, sr_ticket_number));create table customer( c_customer_sk integer not null, c_customer_id char(16) not null, c_current_cdemo_sk integer , c_current_hdemo_sk integer , c_current_addr_sk integer , c_first_shipto_date_sk integer , c_first_sales_date_sk integer , c_salutation char(10) , c_first_name char(20) , c_last_name char(30) , c_preferred_cust_flag char(1) , c_birth_day integer , c_birth_month integer , c_birth_year integer , c_birth_country varchar(20) , c_login char(13) , c_email_address char(50) , c_last_review_date char(10) , primary key (c_customer_sk));create table promotion( p_promo_sk integer not null, p_promo_id char(16) not null, p_start_date_sk integer , p_end_date_sk integer , p_item_sk integer , p_cost decimal(15,2) , p_response_target integer , p_promo_name char(50) , p_channel_dmail char(1) , p_channel_email char(1) , p_channel_catalog char(1) , p_channel_tv char(1) , p_channel_radio char(1) , p_channel_press char(1) , p_channel_event char(1) , p_channel_demo char(1) , p_channel_details varchar(100) , p_purpose char(15) , p_discount_active char(1) , primary key (p_promo_sk));create table customer_address( ca_address_sk integer not null, ca_address_id char(16) not null, ca_street_number char(10) , ca_street_name varchar(60) , ca_street_type char(15) , ca_suite_number char(10) , ca_city varchar(60) , ca_county varchar(30) , ca_state char(2) , ca_zip char(10) , ca_country varchar(20) , ca_gmt_offset decimal(5,2) , ca_location_type char(20) , primary key (ca_address_sk));create table item( i_item_sk integer not null, i_item_id char(16) not null, i_rec_start_date date , i_rec_end_date date , i_item_desc varchar(200) , i_current_price decimal(7,2) , i_wholesale_cost decimal(7,2) , i_brand_id integer , i_brand char(50) , i_class_id integer , i_class char(50) , i_category_id integer , i_category char(50) , i_manufact_id integer , i_manufact char(50) , i_size char(20) , i_formulation char(20) , i_color char(20) , i_units char(10) , i_container char(10) , i_manager_id integer , i_product_name char(50) , primary key (i_item_sk)); 本章节大部分示例使用下述语句，便于Plan Hint支持的各方法作对比，示例语句及不带hint的原计划如下所示：

参数说明 join_table_list为表示表join顺序的hint字符串，可以包含当前层的任意个表（别名），或对于子查询提升的场景，也可以包含子查询的hint别名，同时任意表可以使用括号指定优先级，表之间使用空格分隔。 @queryblock请参见指定Hint所处的查询块Queryblock章节，可省略，表示在当前查询块生效。 表只能用单个字符串表示，不能带schema。 表如果存在别名，需要优先使用别名来表示该表。

参数 表1 数据库连接参数 参数名称 参数说明 host 主机IP地址，也可通过环境变量${PGHOST}来指定。 port 主机服务器的端口号，也可通过环境变量${PGPORT}来指定。 dbname 数据库名，也可通过环境变量${PGDATABASE}来指定。 user 要连接的用户名，也可通过环境变量${PGUSER}来指定。 password 要连接用户对应的连接密码。 connect_timeout 用于连接服务器操作的超时值，也可通过环境变量${PGCONNECT_TIMEOUT}来指定。 sslmode 启用SSL加密的方式，也可通过环境变量${PGSSLMODE}来指定。 参数取值范围： disable：不使用SSL安全连接。 allow：如果数据库服务器要求使用，则可以使用SSL安全加密连接，但不验证数据库服务器的真实性。 prefer：如果数据库支持，那么首选使用SSL安全加密连接，但不验证数据库服务器的真实性。 require：必须使用SSL安全连接，但是只做了 数据加密 ，而并不验证数据库服务器的真实性。 verify-ca：必须使用SSL安全连接，并验证服务器是否具有由可信任的证书机构签发的证书。 verify-full：必须使用SSL安全连接，并且验证服务器是否具有由可信任的证书机构签发的证书，以及验证服务器主机名是否与证书中的一致。 sslkey 指定用于客户端证书的密钥位置，如果需要使用SSL连接，并且该参数未指定，可通过设置环境变量${PGSSLKEY}来指定。 sslcert 指定客户端SSL证书的文件名，或者通过设置环境变量${PGSSLCERT}来指定。 sslrootcert 指定一个包含SSL证书机构（CA）证书的文件名称，或者通过设置环境变量${PGSSLROOTCERT}来指定。 sslcrl 指定SSL证书撤销列表（CRL）的文件名。列在这个文件中的证书如果存在，在尝试认证该服务器证书时会被拒绝，从而连接失败。也可通过环境变量${PGSSLCRL}来指定。 sslpassword 指定对密钥解密成明文的密码短语，当指定该参数的时候表示sslkey是一个加密存储的文件，当前sslkey支持des/aes加密方式。 说明： DES加密算法安全性低，存在安全风险，建议使用更安全的加密算法。 disable_prepared_binary_result 字符串类型，若设置为yes，表示此连接在从预准备语句接收查询结果时不应使用二进制格式。该参数仅用于调试。 取值范围：yes/no。 binary_parameters 字符串类型，该参数表示是否始终以二进制形式发送[]byte。取值范围：yes/no。若该参数设置为yes，建议绑定参数按照[]byte绑定，可以减少内部类型转换。 target_session_attrs 指定数据库的连接类型，该参数用于识别主备节点，也可通过环境变量${PGTARGETSESSIONATTRS}来指定。默认值为“any”，共有六种：any、master、slave、preferSlave、read-write、read-only。 any：尝试连接URL连接串中的任何一个数据节点。 master：尝试连接到URL连接串中的主节点，如果找不到就抛出异常。 slave：尝试连接到URL连接串中的备节点，如果找不到就抛出异常。 preferSlave：尝试连接到URL连接串中的备数据节点（如果有可用的话），否则连接到主数据节点。 read-write：读写模式，表示只能连接主节点。 read-only：只读模式，表示只能连接备节点。 loggerLevel 日志级别，打印相关调试信息，也可通过环境变量${PGLOGGERLEVEL}来指定。 支持trace/debug/info/warn/error/none，级别从高到低。 说明： 日志或报错信息中若含有安全相关关键字（PASSWORD、GS_ENCRYPT、IDENTIFIED等），Go驱动会使用******代替相关信息。 application_name 设置正在使用连接的GO驱动的名称。缺省值为go-driver，该参数不建议用户配置。 RuntimeParams 设置连接会话时默认运行的set类型的guc参数的值。例如参数名search_path、application_name、timezone等。各参数的详细介绍参见客户端连接缺省设置，可通过show语法查看参数是否设置成功。 autoBalance 字符串类型，分布式环境下，使用该参数开启负载均衡连接。默认值为false，共有六种：true、balance、roundrobin、shuffle、priorityn、false。 设置为true、balance或roundrobin时，表示开启go sql负载均衡功能，将应用程序的多个连接均衡到数据库集群中各个可用的CN。 例如： gaussdb://user:password@host1:port1,host2:port2/database?autoBalance=true Driver将定期获取（周期刷新可使用参数refreshCNIpsTime配置，默认为10s）整个集群可用CN列表，比如获取到的列表为：host1:port1,host2:port2,host3:port3,host4:port4。 host1和host2在autoBalance启用时，仅在首次连接做高可用用途，后续Driver将从host3、host4、host1、host2中依次选择可用的CN刷新可用CN列表，后续用户调用的Connector.Connect将使用RoundRobin算法从host1、host2、host3、host4选取CN主机进行连接。 设置为priorityn表示开启Driver优先级负载均衡功能，将应用程序的多个连接首先均衡到url上配置的前n个中可用的CN数据库节点，当url上配置前n个节点全部不可用时，连接会随机分配到数据库集群中其他可用CN数据库节点。n为数字，不小于0，且小于url上配置的CN数量。 例如： gaussdb://user:password@host1:port1,host2:port2,host3:port3/database?autoBalance=priority2 Driver将定期获取（周期按refreshCNIpsTime定义）整个集群可用CN列表，比如获取到的列表为：host1:port1,host2:port2,host3:port3,host4:port4,host5:port5,host6:port6，其中host1和host2处于AZ1，host3和host4处于AZ2。 Driver将从优先从host1，host2中做负载均衡，host1和host2全部不可用才从host3、host4、host5、host6中随机选择CN主机连接。 设置为shuffle表示开启Driver随机负载均衡功能，将应用程序的多个连接随机均衡到数据库集群中的各个可用CN。 例如： gaussdb://user:password@host1:port1,host2:port2,host3:port3/database?autoBalance=shuffle Driver将定期获取(周期刷新可使用参数refreshCNIpsTime配置，默认为10S)整个集群的可用CN列表，比如获取到的列表为：host1:port1,host2:port2,host3:port3,host4:port4。 host1:port1,host2:port2,host3:port3,仅在首次连接做高可用，后续连接将在刷新后的CN列表中，使用shuffle算法随机选用一个CN节点进行连接。 设置为false时为集中式场景，不开启Driver负载均衡功能和优先级负载均衡功能。默认为false。 说明： 负载均衡是基于连接级别，不是基于事务级别。如果连接是长连接，并且连接上的负载不均衡，无法保证CN主机上的负载是均衡的。 负载均衡仅能在分布式场景下使用，集中式环境中不可使用。 recheckTime integer类型，定期检测数据库集群中CN状态，获取可用CN的IP列表的时间间隔，取值范围为5到60秒，默认为10秒。 usingEip 字符串类型。此值用于控制是否使用弹性公网IP做负载均衡。默认值为yes，表示使用弹性公网IP做负载均衡；no表示使用数据IP做负载均衡。

使用分区表 分区表是把逻辑上的一张表根据某种方案分成几张物理块进行存储。这张逻辑上的表称之为分区表，物理块称之为分区。分区表是一张逻辑表，不存储数据，数据实际是存储在分区上的。分区表和普通表相比具有以下优点： 改善查询性能：对分区对象的查询可以仅搜索自己关心的分区，提高检索效率。 增强可用性：如果分区表的某个分区出现故障，表在其他分区的数据仍然可用。 方便维护：如果分区表的某个分区出现故障，需要修复数据，只修复该分区即可。 GaussDB 支持的分区表为范围分区表、列表分区表和哈希分区表。 范围分区表：将数据基于范围映射到每一个分区。这个范围是由创建分区表时指定的分区键决定的。分区键经常采用日期，例如将销售数据按照月份进行分区。 列表分区表：将数据中包含的键值分别存储在不同的分区中，依次将数据映射到每一个分区，分区中包含的键值由创建分区表时指定。 哈希分区表：将数据根据内部哈希算法依次映射到每一个分区中，包含的分区个数由创建分区表时指定。 父主题： 审视和修改表定义

环境类 Go环境配置 用户需要在环境变量中配置以下参数： GO111MODULE：用户使用在线导入的方式安装Go驱动时需要设置GO111MODULE为on。如果不希望进行go mod工程的改造，需将GO111MODULE设置为off，并手动下载依赖包。依赖包与驱动根目录和业务代码保持同级。 GOPROXY：用户使用在线导入时需配置包含Go驱动包的路径。 用户可以根据自己场景参数配置Go其他相关环境变量。 通过go env查看Go环境变量配置结果，并且查看Go版本是否在1.13或以上。 Go驱动安装 从发布包中获取Go驱动包。包名为GaussDB -Kernel_数据库版本号_操作系统版本号_64bit_Go.tar.gz。解压后为Go驱动源码包。 进入Go驱动代码根路径，执行go mod tidy下载相关依赖，需要在环境变量中配置GOPATH=${Go驱动依赖包存放路径}。 若依赖已下载至本地，可以在go.mod里面添加一行“通过replace将Go驱动包替换为本地Go驱动包地址”，表示代码里面所有的import Go驱动包都是使用本地路径，同时依赖也不会从代理里下载。 通过go mod tidy下载相关依赖时可能会下载为某个依赖的低版本，如果依赖的低版本存在漏洞，可以通过更改go.mod文件中对应依赖的版本号，更新依赖到漏洞修复后的版本来规避风险。 用户不涉及驱动开发，调用需go 1.13版本或以上即可，runtime运行库需要更新至1.18版本及以上。

类型映射 当ecpg应用程序在GaussDB Kernel服务器和C语言程序之间交换值时（例如：从服务器检索查询结果或者执行带有输入参数的SQL语句），在GaussDB Kernel数据类型和宿主语言变量类型（具体的C语言数据类型）之间需要进行值的转换。有两种数据类型可以使用：简单的GaussDB Kernel数据类型，如integer和text，可以直接被应用程序读取和写入。其他GaussDB Kernel数据类型，如timestamp和numeric，只能通过特殊库函数进行访问，请参见ecpg接口参考章节。 表1 GaussDB Kernel数据类型和C变量类型之间的映射 GaussDB Kernel数据类型 宿主变量数据类型 smallint short integer int bigint long long int boolean boolean character(n), varchar(n), text char[n+1], VARCHAR[n+1] double precision double real float smallserial short serial int bigserial long long int oid unsigned int name char[NAMEDATALEN] date date [a] timestamp timestamp [a] interval interval [a] decimal decimal [a] numeric numeric [a] [a]这种类型可以通过访问特殊数据类型访问。 当前仅支持对于C语言的基本数据类型的使用或者组合，不支持C++语言中string数据类型用作宿主变量数据类型。 当前ecpg仅对GaussDB Kernel SQL的常用数据类型做映射，具体支持项请参见表1。 父主题： 宿主变量

案例环境准备 为了便于案例演示，需准备建表语句如下： --清理环境DROP SCHEMA IF EXISTS dn_gather_test CASCADE;CREATE SCHEMA dn_gather_test;SET current_schema=dn_gather_test;--创建测试表CREATE TABLE t1(a INT, b INT, c INT, d INT);CREATE TABLE t2(a INT, b INT, c INT, d INT);CREATE TABLE t3(a INT, b INT, c INT, d INT);CREATE TABLE t4(a INT, b INT, c INT, d INT);

示例 声明用于查询的游标示例： EXEC SQL DECLARE C CURSOR FOR SELECT * FROM My_Table; EXEC SQL DECLARE C CURSOR FOR SELECT Item1 FROM T; EXEC SQL DECLARE cur1 CURSOR FOR SELECT version(); 声明用于预备语句的游标示例： EXEC SQL PREPARE stmt1 AS SELECT version(); EXEC SQL DECLARE cur1 CURSOR FOR stmt1;

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开发

参数 表1 psycopg2.connect参数 关键字 参数说明 dbname 数据库名称。 user 用户名。 password 密码。 host 数据库IP地址，可指定多IP，IP间以逗号隔开，默认为UNIX socket类型。 port 连接端口号，默认为5432。host为多IP时，如端口号相同，指定一个端口号。否则，端口号与IP一一对应，以逗号隔开。 sslmode ssl模式，ssl连接时用。 sslcert 客户端证书路径，ssl连接时用。 sslkey 客户端密钥路径，ssl连接时用。 sslrootcert 根证书路径，ssl连接时用。 hostaddr 数据库IP地址。 connect_timeout 客户端连接超时时间。 client_encoding 客户端编码格式。 application_name application_name的参数值。 fallback_application_name application_name参数的回退值。 keepalives 控制是否客户端TCP保持连接，默认为1，表示打开；值为0时，表示关闭。若UNIX域套接字连接，则忽略。 options 连接开始时发送给服务器的命令行选项。 keepalives_idle 控制向服务器发送keepalive消息之前不活动的描述，若keepalive被禁用，则忽略此参数。 keepalives_interval 控制未得到服务器确认的keepalive消息应重新传输的描述，若keepalive被禁用，则忽略此参数。 keepalives_count 控制客户端与服务端连接断开之前可能丢失的tcp保持连接的数量。 replication 确认连接使用的是复制协议而不是普通协议。 requiressl 支持sslmode设置。 sslcompression ssl压缩。设置为1，则通过ssl连接发送的数据将被压缩；设置为0，则禁用压缩。若没有建立ssl的连接，则忽略此参数。 sslcrl 证书吊销列表文件路径，验证ssl服务端证书是否可用。 requirepeer 指定服务器的操作系统用户名。 target_session_attrs 设定连接的主机的类型。主机的类型和设定的值一致时才能连接成功。指定多IP时才会校验此参数。target_session_attrs的设置规则如下： any：可以对所有类型的主机进行连接。 read-write：当连接的主机允许可读可写时，才进行连接。 read-only：仅对可读的主机进行连接。 primary（默认值）：仅对主备系统中的主机能进行连接。 standby：仅对主备系统中的备机进行连接。 prefer-standby：首先尝试找到一个备机进行连接。如果对hosts列表的所有机器都连接失败，那么尝试“any”模式进行连接。 tcp_user_timeout 在支持TCP_USER_TIMEOUT套接字选项的操作系统上，指定传输的数据在TCP连接被强制关闭之前可以保持未确认状态的最大时长。0值表示使用系统缺省。通过Unix域套接字做的连接忽略这个参数。 rw_timeout 设置客户端连接读写超时时间。 当libpq侧触发超时且连接关闭时，其下发给数据库侧正在运行的业务会被强制终止。该能力受GUC参数check_disconnect_query控制，设置为on表示支持该能力，设置为off表示不支持该能力。

ecpg组件介绍 ecpg支持平台 表1 ecpg支持平台 操作系统 平台 EulerOS V2.0SP5 x86_64位 EulerOS V2.0SP9 ARM64位 Kylin V10 x86_64位 Kylin V10 ARM64位 ecpg组件 ecpg：用于对嵌入式SQL-C进行预处理的可执行二进制文件。 libecpg：为ecpg提供连接、执行SQL、事务等实现的动态库，包括libecpg.so、libecpg.so.6和libecpg.so.6.4，在C语言程序编译执行时通过“-lecpg”参数引用。 libpgtypes：ecpg提供的用于实现数值、日期、时间戳、区间类型数据操作运算的动态库，包括libpgtypes.so、libecpg.so.6和libecpg.so.6.4，在C语言程序编译执行时通过“-lpgtypes”参数引用。 ecpg组件的获取路径 ecpg二进制获取路径：$GAUSSHOME/bin ecpg依赖动态库路径：$GAUSSHOME/lib ecpg所需头文件路径：$GAUSSHOME/include/ecpg 父主题： 基于ecpg开发

参数说明 @queryblock请参见指定Hint所处的查询块Queryblock章节，可省略，表示在当前查询块生效，该hint只在指定为最外层的queryblock时才会生效。 param：表示参数名。 value：表示参数的取值。 目前支持使用hint设置生效的参数有： 布尔类： enable_bitmapscan、enable_hashagg、enable_hashjoin、enable_indexscan、enable_indexonlyscan、enable_gsiscan、enable_gsitablescan、enable_material、enable_mergejoin、enable_nestloop、enable_index_nestloop、enable_seqscan、enable_sort、enable_tidscan、enable_stream_operator、enable_stream_recursive、enable_broadcast、enable_fast_query_shipping、enable_trigger_shipping、enable_remotejoin、enable_remotegroup、enable_remotelimit、enable_remotesort、enable_inner_unique_opt、enable_invisible_indexes 整型类： best_agg_plan，query_dop 浮点类： cost_weight_index、default_limit_rows、seq_page_cost、random_page_cost、cpu_tuple_cost、cpu_index_tuple_cost、cpu_operator_cost、effective_cache_size 枚举类： try_vector_engine_strategy 字符串类： node_name 通过设置node_name可以指定当前的sql下发到node_name对应的DN上去执行。 示例： select /*+ set(node_name datanode1) */ from table_name; 其中，datanode1是从pgxc_node系统表里查询出的数据节点的名称（不用加引号），table_name是表名。该查询表示直接去datanode1上执行查询。 node_name只支持在select语句里设置，如果在其他语句里设置将不生效。 node_name只支持设置data node名字，不支持设置coodninator名字。 node_name不支持通过SET语句进行修改，只能用在plan hint里。 node_name不支持通过gs_guc进行修改。 node_name仅支持简单查询语句，不支持带union，union all子查询，多表关联等复杂查询语句。 支持普通用户执行。 不支持与行级访问控制同时使用，同时使用会报错。 设置不在白名单中的参数，参数取值不合法，或hint语法错误时，不会影响查询执行的正确性。使用explain(verbose on)执行可以看到hint解析错误的报错提示。 GUC参数的hint只在最外层查询生效，子查询内的GUC参数hint不生效。 视图定义内的GUC参数hint不生效。 CREATE TABLE ... AS ...查询最外层的GUC参数hint可以生效。

统计信息调优介绍 GaussDB是基于代价估算生成的最优执行计划。优化器需要根据analyze收集的统计信息进行行数估算和代价估算，因此统计信息对优化器行数估算和代价估算起着至关重要的作用。通过analyze收集全局统计信息，主要包括：PG_CLASS系统表中的relpages和reltuples，pg_statistic表中的stadistinct、stanullfrac、stanumbersN、stavaluesN、histogram_bounds等。

算子级调优介绍 一个查询语句要经过多个算子步骤才会输出最终的结果。由于个别算子耗时过长导致整体查询性能下降的情况比较常见。这些算子是整个查询的瓶颈算子。通用的优化手段是EXPLAIN ANALYZE/PERFORMANCE命令查看执行过程的瓶颈算子，然后进行针对性优化。 如下面的执行过程信息中，Hashagg算子的执行时间占总时间的：(51016-13535)/ 56476 ≈66%，此处Hashagg算子就是这个查询的瓶颈算子，在进行性能优化时应当优先考虑此算子的优化。

选择分布列 Hash分布表的分布列选取至关重要，需要满足以下原则： 列值应比较离散，以便数据能够均匀分布到各个DN。例如，考虑选择表的主键为分布列，如在人员信息表中选择身份证号码为分布列。 在满足第一条原则的情况下尽量不要选取存在常量filter的列。例如，表dwcjk相关的部分查询中出现dwcjk的列zqdh存在常量的约束(例如zqdh=‘000001’)，那么尽量不用zqdh做分布列。 在满足前两条原则的情况下，考虑选择查询中的连接条件为分布列，以便Join任务能够下推到DN中执行，且减少DN之间的通信数据量。 对于Hash分表策略，如果分布列选择不当，可能导致数据倾斜，查询时出现部分DN的I/O短板，从而影响整体查询性能。因此在采用Hash分表策略之后需对表的数据进行数据倾斜性检查，以确保数据在各个DN上是均匀分布的。可以使用以下SQL检查数据倾斜性： 12345 select xc_node_id, count(1) from tablename group by xc_node_id order by xc_node_id desc; 其中xc_node_id对应DN，一般来说，不同DN的数据量相差5%以上即可视为倾斜，如果相差10%以上就必须要调整分布列。 GaussDB支持多分布列特性，可以更好地满足数据分布的均匀性要求。 Range/List分布表的分布列由用户根据实际需要进行选择。除了需要选择合适的分布列，还需要注意分布规则对数据分布的影响。 父主题： 审视和修改表定义

define和undef指令 在嵌入式SQL程序中也可以使用C语言版本的#define和#undef。区别在于定义的值会在哪里被计算，如果使用EXEC SQL DEFINE，那么ecpg预处理阶段会计算这些定义并替换值。如果使用C语言版本的#define和#undef，那么会在编译器处理阶段会计算这些定义并替换值。 不能把#define用于一个将要在嵌入式SQL查询中使用的变量，因为在这种情况下嵌入式SQL预编译器不能看到这个声明。 父主题： 预处理指令

事务管理 在ecpg缺省模式下，语句只有在EXEC SQL COMMIT发出的时候才被提交，嵌入的SQL接口也支持事务的自动提交（通过EXEC SQL SET AUTOCOMMIT TO ON语句设置自动提交）。在自动提交模式下，每条命令都是自动提交的，除非它们包围在一个明确的事务块里。自动提交模式可以用EXEC SQL SET AUTOCOMMIT TO OFF语句关闭。 常见事务管理命令如下： EXEC SQL COMMIT：提交正在进行的事务。 EXEC SQL ROLLBACK：回滚正在进行的事务。 EXEC SQL SET AUTOCOMMIT TO ON：启动自动提交模式。 EXEC SQL SET AUTOCOMMIT TO OFF：关闭自动提交模式，缺省模式。 父主题： 执行SQL命令

示例 EXEC SQL SET DESCRIPTOR indesc COUNT = 1; EXEC SQL SET DESCRIPTOR indesc VALUE 1 DATA = 2; EXEC SQL SET DESCRIPTOR indesc VALUE 1 DATA = :val1; EXEC SQL SET DESCRIPTOR indesc VALUE 2 INDICATOR = :val1, DATA = 'some string'; EXEC SQL SET DESCRIPTOR indesc VALUE 2 INDICATOR = :val2null, DATA = :val2;

声明段 要实现嵌入式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段中列出，否则预处理器就无法处理这些类型。 父主题： 宿主变量