华为云用户手册

功能描述 在指定的表上创建索引。 索引可以用来提高数据库查询性能，但是不恰当的使用将导致数据库性能下降。建议仅在匹配如下某条原则时创建索引： 经常执行查询的字段。 在连接条件上创建索引，对于存在多字段连接的查询，建议在这些字段上建立组合索引。例如select * from t1 join t2 on t1.a=t2.a and t1.b=t2.b，可以在t1表上的a，b字段上建立组合索引。 where子句的过滤条件字段上（尤其是范围条件）。 在经常出现在order by、group by和distinct后的字段。 在分区表上创建索引与在普通表上创建索引的语法不太一样，使用时请注意，如当索引带GLOBAL/LOCAL关键字或者创建索引为GLOBAL索引时不支持创建部分索引。需要注意分区表上创建索引会根据如下规则进行判断：如果创建索引时申明了GLOBAL/LOCAL关键字，则创建对应类型的索引；否则如果创建索引指定分区名，则创建LOCAL索引；否则如果是unique索引，包含非分区键时创建GLOBAL索引，包含全部分区键则创建LOCAL索引；否则默认创建GLOBAL索引。

注意事项 索引自身也占用存储空间、消耗计算资源，创建过多的索引将对数据库性能造成负面影响（尤其影响数据导入的性能，建议在数据导入后再建索引）。因此，仅在必要时创建索引。 索引定义里的所有函数和操作符都必须是immutable类型的，即它们的结果必须只能依赖于它们的输入参数，而不受任何外部的影响（如另外一个表的内容或者当前时间）。这个限制可以确保该索引的行为是定义良好的。要在一个索引上或WHERE中使用用户定义函数，请把它标记为immutable类型函数。 分区表索引分为LOCAL索引与GLOBAL索引，LOCAL索引与某个具体分区绑定，而GLOBAL索引则对应整个分区表。 被授予CREATE ANY INDEX权限的用户，可以在public模式和用户模式下创建索引。 如果表达式索引中调用的是用户自定义函数，按照函数创建者权限执行表达式索引函数。 不支持XML类型数据作为普通索引、UNIQUE索引、GLOBAL索引、LOCAL索引、部分索引。 在线创建索引的类型只支持btree索引和ubtree索引。索引创建形式只支持非分区表普通索引及分区表GLOBAL索引、LOCAL索引，不支持PCR ubtree索引、二级分区与GSI。在线并行创建索引只支持Astore及Ustore的普通索引、GLOBAL索引、LOCAL索引。

优化建议 create index 约束限制： 普通表的索引支持最大列数为32列；分区表的GLOBAL索引支持最大列数为31列。 单个索引大小不能超过索引页面大小（8k），其中B-tree、UBtree不能超过页面大小的三分之一。 分区表上不支持创建部分索引。 分区表创建GLOBAL索引时，存在以下约束条件： 不支持表达式索引、部分索引。 仅支持Btree索引。 在相同属性列上，分区LOCAL索引与GLOBAL索引不能共存。 如果ALTER语句不带有UPDATE GLOBAL INDEX，那么原有的GLOBAL索引将失效，查询时将使用其他索引进行查询；如果ALTER语句带有UPDATE GLOBAL INDEX，原有的GLOBAL索引仍然有效，并且索引功能正确。

语法格式 在表上创建索引。 CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ IF NOT EXISTS ] [ [schema_name.] index_name ] ON table_name [ USING method ] ({ { column_name [ ( length ) ] | ( expression ) } [ COLLATE collation ] [ opclass ] [ ASC | DESC ] [ NULLS { FIRST | LAST } ] }[, ...] ) [ INCLUDE ( column_name [, ...] ) ] [ WITH ( {storage_parameter = value} [, ... ] ) ] [ TABLESPACE tablespace_name ] { [ COMMENT 'string' ] [ ... ] } [ { VISIBLE | INVISIBLE } ] [ WHERE predicate ]; 在分区表上创建索引。 CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [schema_name.] index_name ] ON table_name [ USING method ] ( { { column_name [ ( length ) ] | ( expression ) } [ COLLATE collation ] [ opclass ] [ ASC | DESC ] [ NULLS LAST ] } [, ...] ) [ LOCAL [ ( { PARTITION index_partition_name [ FOR { partition_name | ( partition_value [, ...] ) } ] [ TABLESPACE index_partition_tablespace ] [ ( [SUBPARTITION index_subpartition_name] [ FOR { partition_name | ( partition_value [, ...] ) } ] [ TABLESPACE index_partition_tablespace ] [, ...] ) ] [, ...] } ) ] | GLOBAL ] [ INCLUDE ( column_name [, ...] ) ] [ WITH ( { storage_parameter = value } [, ...] ) ] [ TABLESPACE tablespace_name ] { [ COMMENT 'string' ] [ ... ] } [ { VISIBLE | INVISIBLE } ];

示例 普通索引 --创建tbl_test1表。 gaussdb=# CREATE TABLE tbl_test1( id int, --用户id name varchar(50), --用户姓名 postcode char(6) --邮编 ); --创建表空间tbs_index1。 gaussdb=# CREATE TABLESPACE tbs_index1 RELATIVE LOCATION 'test_tablespace/tbs_index1'; --为表tbl_test1创建索引idx_test1指定表空间。 gaussdb=# CREATE INDEX idx_test1 ON tbl_test1(name) TABLESPACE tbs_index1; --查询索引idx_test1信息。 gaussdb=# SELECT indexname,tablename,tablespace FROM pg_indexes WHERE indexname = 'idx_test1'; indexname | tablename | tablespace -----------+-----------+------------ idx_test1 | tbl_test1 | tbs_index1 (1 row) --删除索引。 gaussdb=# DROP INDEX idx_test1; --删除表空间。 gaussdb=# DROP TABLESPACE tbs_index1; 唯一索引 --为表tbl_test1创建唯一索引idx_test2。 gaussdb=# CREATE UNIQUE INDEX idx_test2 ON tbl_test1(id); --查询索引信息。 gaussdb=# \d tbl_test1 Table "public.tbl_test1" Column | Type | Modifiers ----------+-----------------------+----------- id | integer | name | character varying(50) | postcode | character(6) | Indexes: "idx_test2" UNIQUE, btree (id) TABLESPACE pg_default --删除索引。 gaussdb=# DROP INDEX idx_test2; 表达式索引 --为表tbl_test1创建一个表达式索引。 gaussdb=# CREATE INDEX idx_test3 ON tbl_test1(substr(postcode,2)); --查询索引信息。 gaussdb=# \d tbl_test1 Table "public.tbl_test1" Column | Type | Modifiers ----------+-----------------------+----------- id | integer | name | character varying(50) | postcode | character(7) | Indexes: "idx_test3" btree (substr(postcode::text, 2)) TABLESPACE pg_default --删除索引。 gaussdb=# DROP INDEX idx_test3; 部分索引 --为表tbl_test1中id不为为空的数据建立索引。 gaussdb=# CREATE INDEX idx_test4 ON tbl_test1(id) WHERE id IS NOT NULL; --删除索引。 gaussdb=# DROP INDEX idx_test4; --删除表。 gaussdb=# DROP TABLE tbl_test1; 分区索引 --建表。 gaussdb=# CREATE TABLE student(id int, name varchar(20)) PARTITION BY RANGE (id) ( PARTITION p1 VALUES LESS THAN (200), PARTITION pmax VALUES LESS THAN (MAXVALUE) ); --创建LOCAL分区索引不指定索引分区的名称。 gaussdb=# CREATE INDEX idx_student1 ON student(id) LOCAL; --查看索引分区信息，发现LOCAL索引分区数和表的分区数一致。 gaussdb=# SELECT relname FROM pg_partition WHERE parentid = 'idx_student1'::regclass; relname ------------- p1_id_idx pmax_id_idx (2 rows) --删除LOCAL分区索引。 gaussdb=# DROP INDEX idx_student1; --创建GLOBAL索引。 gaussdb=# CREATE INDEX idx_student2 ON student(name) GLOBAL; --查看索引分区信息，发现GLOBAL索引分区数和表的分区数不一致。 gaussdb=# SELECT relname FROM pg_partition WHERE parentid = 'idx_student2'::regclass; relname --------- (0 rows) --删除GLOBAL分区索引。 gaussdb=# DROP INDEX idx_student2; --创建LOCAL表达式索引，不指定索引分区的名称。 gaussdb=# CREATE INDEX idx_student3 ON student(lower(name)) LOCAL; --查看索引分区信息，发现LOCAL索引分区数和表的分区数一致。 gaussdb=# SELECT relname FROM pg_partition WHERE parentid = 'idx_student3'::regclass; relname ------------- p1_id_idx pmax_id_idx (2 rows) --删除LOCAL分区表达式索引。 gaussdb=# DROP INDEX idx_student3; --创建GLOBAL表达式索引。 gaussdb=# CREATE INDEX idx_student4 ON student(lower(name)) GLOBAL; --查看索引分区信息，GLOBAL表达式索引分区数和表的分区数不一致。 gaussdb=# SELECT relname FROM pg_partition WHERE parentid = 'idx_student4'::regclass; relname --------- (0 rows) --删除GLOBAL分区表达式索引。 gaussdb=# DROP INDEX idx_student4; --删除表。 gaussdb=# DROP TABLE student;

背景信息 初始时，GaussDB包含三个模板数据库template0、template1、templatem以及一个默认的用户数据库postgres。postgres默认的兼容数据库类型为O（即DBCOMPATIBILITY = A ），该兼容类型下将空字符串作为NULL处理。 CREATE DATABASE实际上通过复制模板数据库来创建新数据库。默认情况下，复制template0。请避免使用客户端或其他方式连接及操作两个模板数据库。 模板数据库中没有用户表，可通过系统表PG_DATABASE查看模板数据库属性。 模板template0不允许用户连接，模板template1和templatem只允许数据库初始用户和系统管理员连接，普通用户无法连接。 数据库系统中会有多个数据库，但是客户端程序一次只能连接一个数据库。也不能在不同的数据库之间相互查询。GaussDB中存在多个数据库时，需要通过-d参数指定相应的数据库实例进行连接。

注意事项 如果数据库的编码为SQL_ASCII（可以通过“show server_encoding;”命令查看当前数据库存储编码），则在创建数据库对象时，如果对象名中含有多字节字符（例如中文），超过数据库对象名长度限制（63字节）的时候，数据库将会将最后一个字节（而不是字符）截断，可能造成出现半个字符的情况。 针对这种情况，请遵循以下条件： 保证数据对象的名称不超过限定长度。 修改数据库的默认存储编码集（server_encoding）为utf-8编码集。 不要使用多字节字符作为对象名。 当出现因为误操作导致在多字节字符的中间截断，从而导致无法删除数据库对象的现象时，请使用截断前的数据库对象名进行删除操作，或将该对象从各个数据库节点的相应系统表中依次删除。

vector_spherical_distance 功能说明：计算两个归一化向量的球面距离（余弦夹角的弧度制表示） 入参1的类型：floatvector 入参2的类型：floatvector 出参类型：float8 代码示例： gaussdb=# gaussdb=# select vector_spherical_distance('[1,0,0,0]', '[0,0,0,1]'); 如果输入向量非归一化，无法获得正确的计算结果。

cosine_distance 功能说明：计算两个向量的余弦距离 入参1的类型：floatvector 入参2的类型：floatvector 出参类型：float8 代码示例： gaussdb=# select cosine_distance(floatvector('[1,2,3]'), floatvector('[5,-1,3.5]')); gaussdb=# select cosine_distance('[1,2,3]', '[5,-1,3.5]');

l2_distance 功能说明：计算两个向量的欧式距离。 入参1的类型：floatvector 入参2的类型：floatvector 出参类型：float8 代码示例： gaussdb=# SELECT l2_distance(floatvector('[1,2,3]'), floatvector('[5,-1,3.5]')); gaussdb=# SELECT l2_distance('[1,2,3]', '[5,-1,3.5]');

vector_l2_squared_distance 功能说明：获得两个向量的欧式距离的平方。 入参1的类型：floatvector 入参2的类型：floatvector 出参类型：float8 代码示例： gaussdb=# SELECT vector_l2_squared_distance(floatvector('[1,2,3]'), floatvector('[5,-1,3.5]')); gaussdb=# SELECT vector_l2_squared_distance('[1,2,3]', '[5,-1,3.5]');

GLOBAL_REPLICATION_SLOTS GLOBAL_REPLICATION_SLOTS视图用于查看数据库各节点的复制槽的信息，如表1所示。 表1 GLOBAL_REPLICATION_SLOTS字段 名称 类型 描述 node_name name 节点名称。 slot_name text 复制槽的名称。 plugin text 逻辑复制槽对应的输出插件名称。 slot_type text 复制槽的类型。 physical：物理复制槽。 logical：逻辑复制槽。 datoid oid 复制槽所在的数据库OID。 database name 复制槽所在的数据库名称。 active boolean 复制槽是否为激活状态。 t（true）：表示是。 f（false）：表示不是。 x_min xid 数据库须为复制槽保留的最早事务的事务号。 catalog_xmin xid 数据库须为逻辑复制槽保留的最早的涉及系统表的事务的事务号。 restart_lsn text 复制槽需要的最早xlog的物理位置。 dummy_standby boolean 预留参数。 父主题： Utility

参数 表1 PQexecPreparedBatch参数 关键字 参数说明 conn 连接句柄。 stmtName stmt名称，可以用""或者NULL来引用未命名语句，否则它必须是一个现有预备语句的名字。 nParams 参数个数。 nBatchCount 批量数。 paramValues 参数的实际值。 paramLengths 参数的实际数据长度。 paramFormats 参数的格式（文本或二进制）。 resultFormat 结果的格式（文本或二进制）。

原型 PGresult* PQexecPreparedBatch(PGconn* conn, const char* stmtName, int nParams, int nBatchCount, const char* const* paramValues, const int* paramLengths, const int* paramFormats, int resultFormat);

SUMMARY_WORKLOAD_SQL_COUNT 显示数据库内各数据库主节点的workload上的SQL数量分布，如表1所示。 表1 SUMMARY_WORKLOAD_SQL_COUNT字段 名称 类型 描述 node_name name 节点名称。 workload name 负载名称。 select_count bigint select数量。 update_count bigint update数量。 insert_count bigint insert数量。 delete_count bigint delete数量。 ddl_count bigint ddl数量。 dml_count bigint dml数量。 dcl_count bigint dcl数量。 父主题： Workload

参数 表1 数据库连接参数 参数 描述 url gaussdbjdbc.jar数据库连接描述符。 host为服务器名称或IPv4时，格式如下： jdbc:gaussdb:(数据库名称缺省则与用户名一致) jdbc:gaussdb:database jdbc:gaussdb://host/database jdbc:gaussdb://host:port/database jdbc:gaussdb://host:port/database?param1=value1¶m2=value2 jdbc:gaussdb://host1:port1,host2:port2/database?param1=value1¶m2=value2 host为IPv6时，格式如下： jdbc:gaussdb:(数据库名称缺省则与用户名一致) jdbc:gaussdb:database jdbc:gaussdb://host/database 或 jdbc:gaussdb://[host]/database jdbc:gaussdb://[host]:port/database jdbc:gaussdb://[host]:port/database?param1=value1¶m2=value2 jdbc:gaussdb://[host1]:port1,[host2]:port2/database?param1=value1¶m2=value2 说明： database为要连接的数据库名称。 host为数据库服务器名称或IP地址，同时支持IPv4和IPv6。 由于安全原因，数据库主节点禁止数据库内部其他节点无认证接入。如果要在数据库内部访问数据库主节点，请将JDBC程序部署在数据库主节点所在机器，host使用“127.0.0.1”。否则可能会出现“FATAL: Forbid remote connection with trust method!”错误。 建议业务系统单独部署在数据库外部，否则可能会影响数据库运行性能。 缺省情况下，连接服务器为localhost。 port为数据库服务器端口。 缺省情况下，会尝试连接到5432端口的database。 当host为IPv6且在url中指定port时，需要通过“[]”分隔IP，如：[IP]:port。 param为参数名称，即数据库连接属性。 参数可以配置在URL中，以“?”开始配置，以“=”给参数赋值，以“&”作为不同参数的间隔。也可以采用info对象的属性方式进行配置，详情见示例。 value为参数值，即数据库连接属性值。 连接时需配置connectTimeout、socketTimeout，如果未配置，默认为0，即不会超时。在DN与客户端出现网络故障时，客户端一直未收到DN侧ACK确认报文，会启动超时重传机制，不断的进行重传。当超时时间达到系统默认的600s后才会报超时错误，这会导致RTO时间很高。 建议使用JDBC标准接口建立连接时，确保url格式的合法性，不合法的url会导致异常，且异常中包含原始url字符串，可能造成敏感信息泄漏。 info 数据库连接属性（所有属性大小写敏感）。常用的属性如下： PGDBNAME：String类型。表示数据库名称（URL中无需配置该参数，自动从URL中解析）。 PGHOST：String类型。主机IP地址，同时支持IPv4和IPv6。详情见示例。 PGPORT：Integer类型。主机端口号。详情见示例。 user：String类型。表示创建连接的数据库用户。 password：String类型。表示数据库用户的密码。 enable_ce：String类型。其中enable_ce=1表示JDBC支持密态等值查询基本能力，enable_ce=3表示在密态等值查询能力的基础上支持内存解密逃生通道。 key_info：String类型。与enable_ce一起使用，在密态数据库中，用于设置访问外部密钥管理者的参数。 refreshClientEncryption：String类型。缺省值为NULL。refreshClientEncryption=1表示密态数据库支持客户端缓存刷新（默认值为1）。 loggerLevel：String类型。缺省值为NULL，不启用。目前支持4种级别：OFF、INFO、DEBUG、TRACE。设置为OFF关闭日志。设置为INFO、DEBUG和TRACE记录的日志信息详细程度不同。 loggerFile：String类型。用于指定日志输出路径（目录和文件名）。需要明确指定日志目录和文件名，若未指定目录则会在客户端运行程序目录下生成日志文件。此参数已废弃，不再生效，仅在开启连接监控功能时用于指定输出监控日志路径，如需将JDBC日志输出到指定路径，可通过 java.util.logging 属性文件或系统属性进行配置。 logger：String类型。表示JDBC Driver要使用的日志输出框架。JDBC Driver支持对接用户应用程序使用的日志输出框架。目前支持的第三方日志输出框架只有基于Slf4j-API的日志框架。具体使用方式，请参见日志管理。如果缺省或设置为JDK LOGGER，则JDBC Driver使用JDK LOGGER。否则必须设置采用基于slf4j-API 第三方日志框架。 allowEncodingChanges：Boolean类型。缺省值为false。设置该参数值为true进行字符集类型更改，配合参数characterEncoding设置字符集，二者使用“&”分隔。characterEncoding取值范围为UTF8、GBK、LATIN1、GB18030、GB18030_2022、ZHS16GBK。例：allowEncodingChanges=true&characterEncoding=UTF8。 说明： ZHS16GBK字符集支持欧元符号。如果要显示欧元符号，请将字符集设置为ZHS16GBK。 currentSchema：String类型。在search-path中指定要设置的schema。如果schema名包含除字母、数字、下划线之外的特殊字符，建议在schema名上加引号，注意schema名大小写敏感。如需配置多个schema，要用逗号（,）进行分隔，包含特殊字符的schema也需要加引号处理。 例如：currentSchema=schema_a、"schema-b"、"schema/c"。 hostRecheckSeconds：Integer类型。JDBC尝试连接主机后会保存主机状态：连接成功或连接失败。在hostRecheckSeconds时间内保持可信，超过则状态失效。缺省值是10秒。 ssl：Boolean类型。以SSL方式连接。 ssl=true可支持NonValidatingFactory通道和使用证书的方式： 1、NonValidatingFactory通道需要配置用户名和密码，同时将SSL设置为true。 2、配置客户端证书、密钥、根证书，将SSL设置为true。 sslmode：String类型。SSL认证方式。取值范围为：disable、allow、prefer、require、verify-ca、verify-full。 disable：不使用SSL安全连接。 allow：如果数据库服务器要求使用，则可以使用SSL安全加密连接，但不验证数据库服务器的真实性。 prefer：如果数据库支持，那么首选使用SSL连接，但不验证数据库服务器的真实性。 require只尝试SSL连接，如果存在CA文件，则应设置成verify-ca的方式验证。 verify-ca只尝试SSL连接，并且验证服务器是否具有由可信任的证书机构签发的证书。 verify-full只尝试SSL连接，并且验证服务器是否具有由可信任的证书机构签发的证书，以及验证服务器主机名是否与证书中的一致。 sslcert：String类型。提供证书文件的完整路径。客户端和服务端证书的类型为End Entity。 sslkey：String类型。提供密钥文件的完整路径。使用时将客户端证书转换为DER格式。 openssl pkcs8 -topk8 -outform DER -in client.key -out client.key.pk8 -nocrypt sslrootcert：String类型。SSL根证书的文件名。根证书的类型为CA。 sslpassword：String类型。提供给ConsoleCallbackHandler使用。 sslpasswordcallback：String类型。SSL密码提供者的类名。缺省值：com.huawei.gaussdb.jdbc.ssl.jdbc4.LibPQFactory.ConsoleCallbackHandler。 sslfactory：String类型。提供的值是SSLSocketFactory在建立SSL连接时用的类名。 sslprivatekeyfactory: String类型。提供的值是实现私钥解密方法的接口com.huawei.gaussdb.jdbc.ssl.PrivateKeyFactory的实现类的完整限定类名。如果不提供，首先尝试默认的jdk私钥解密算法，如果无法解密，则使用com.huawei.gaussdb.jdbc.ssl.BouncyCastlePrivateKeyFactory，用户需要提供bcpkix-jdk15on.jar包，版本建议：1.65以上。 sslfactoryarg：String类型。此值是sslfactory类的构造函数的可选参数（不推荐使用）。 sslhostnameverifier：String类型。主机名验证程序的类名。接口实现javax.net.ssl.HostnameVerifier，默认使用com.huawei.gaussdb.jdbc.ssl.PGjdbcHostnameVerifier。 loginTimeout：Integer类型。指建立数据库连接的等待时间。超时时间单位为秒。当url配置多IP时，若获取连接花费的时间超过此值，则连接失败，不再尝试后续IP。缺省值为0。 connectTimeout：Integer类型。用于连接服务器操作的超时值。如果连接到服务器花费的时间超过此值，则连接断开。超时时间单位为秒，值为0时表示已禁用，timeout不生效。当url配置多IP时，表示连接单个IP的超时时间。缺省值为0。 socketTimeout：Integer类型。用于socket读取操作的超时值。如果从服务器读取所花费的时间超过此值，则连接关闭。超时时间单位为秒，值为0时表示已禁用，timeout不生效。缺省值为0。如果不配置该参数，在数据库进程异常情况下，会导致客户端出现长时间等待，建议根据业务可接受的SQL执行时间进行配置。 当JDBC侧触发超时且连接关闭时，其下发给数据库侧正在运行的业务会被强制终止。该能力受GUC参数check_disconnect_query控制，设置为on表示支持该能力，设置为off表示不支持该能力。 socketTimeoutInConnecting：Integer类型。用于控制建连阶段socket读取操作的超时值。如果建连时从服务器读取所花费的时间超过此值，则查找下一个节点建连。超时时间单位为秒，默认为5s。 statementTimeout：Integer类型。用于控制connection中statement执行时间的超时值。如果statement执行时间超过此值，则取消该statement执行。超时时间单位为毫秒，值为0表示已禁用，timeout不生效，缺省值为0。 cancelSignalTimeout：Integer类型。发送取消消息本身可能会阻塞，用于控制取消命令的“connect超时”和“socket超时”。如果取消命令超过指定时间未响应，会中断该连接，减少占用客户端资源。超时时间单位为秒，默认值为10秒。 tcpKeepAlive：Boolean类型。启用或禁用TCP保活探测功能。默认为false。 logUnclosedConnections：Boolean类型，缺省值为false。客户端可能由于未调用Connection对象的close()方法而泄漏Connection对象。最终这些对象将被垃圾回收，并且调用finalize()方法。设置为true之后，如果调用者忽略了此操作，该方法将关闭Connection。 assumeMinServerVersion（废弃）：String类型。客户端会发送请求进行float精度设置。该参数设置要连接的服务器版本，如assumeMinServerVersion=9.0，可以在建立时减少相关包的发送。 ApplicationName：String类型。设置正在使用连接的JDBC驱动的名称。通过在数据库主节点上查询pg_stat_activity表可以看到正在连接的客户端信息，JDBC驱动名称显示在application_name列。缺省值为GaussDB JDBC Driver。 connectionExtraInfo：Boolean类型。表示驱动是否将当前驱动的部署路径、进程属主用户、url连接配置信息上报到数据库。 取值范围：true或false，默认值为false。设置connectionExtraInfo为true，JDBC驱动会将当前驱动的部署路径、进程属主用户、url连接配置信息上报到数据库中，记录在connection_info参数里，同时可以在PG_STAT_ACTIVITY中查询到。 autosave：String类型。共有3种："always"、 "never"、 "conservative"，缺省值为never。如果查询失败，指定驱动程序应该执行的操作。在autosave=always模式下，JDBC驱动程序在每次查询之前设置一个保存点，并在失败时回滚到该保存点。在autosave=never模式（默认）下，无保存点。在autosave=conservative模式下，每次查询都会设置保存点，但是只会在“statement XXX无效”等情况下回滚并重试。 protocolVersion：Integer类型。连接协议版本号，目前仅支持1和3。设置1时仅代表连接的是V1服务端。设置3时将采用MD5加密方式，需要同步修改数据库的加密方式，将GUC参数password_encryption_type设置为1，重启数据库生效后需要创建用MD5方式加密口令的用户。同时修改gs_hba.conf，将客户端连接方式修改为MD5，用新建用户进行登录（因为设置该值后，只能使用低等级的加密方式（MD5），降低安全性，所以不推荐设置）。 说明： MD5加密算法安全性低，存在安全风险，建议使用更安全的加密算法。 prepareThreshold：Integer类型。该值决定着PreparedStatement对象在执行多少次以后使用服务端已经准备好的statement。默认值是5，意味着在执行同一个PreparedStatement对象时，在第五次以及以上执行时不再向服务端发送parse消息对statement进行解析，而使用之前在服务端已经解析好的statement。 preparedStatementCacheQueries：Integer类型。确定每个连接中缓存的查询数，默认情况下是256。若在prepareStatement()调用中使用超过256个不同的查询，则最近最少使用的查询缓存将被丢弃。“0”表示禁用缓存。 preparedStatementCacheSizeMiB：Integer类型。该参数确定了每个连接的cache缓存Statement对象所生成query的最大值（以兆字节为单位），默认情况下是5。若缓存了超过5MB的query，则最近最少使用的查询缓存将被丢弃。“0”表示禁用缓存。 databaseMetadataCacheFields：Integer类型。默认值是65536。指定每个连接可缓存的最大字段的个数。“0”表示禁用缓存。 databaseMetadataCacheFieldsMiB：Integer类型。默认值是5。每个连接可缓存的字段的最大值，单位是MB。“0”表示禁用缓存。 stringtype：String类型。可选字段为：unspecified、varchar。设置通过setString()方法使用的PreparedStatement参数的类型，如果stringtype设置为VARCHAR（默认值），则这些参数将作为varchar参数发送给服务器。若stringtype设置为unspecified，则参数将作为untyped值发送到服务器，服务器将尝试推断适当的类型。 batchMode：String类型。用于确定是否使用batch模式连接。默认值为on，表示开启batch模式。设置batchMode=on执行成功的返回结果为[count, 0, 0...0]，数组第一个元素为批量影响的总条数，设置batchMode=off执行成功的返回结果为[1, 1, 1...1]，数组各元素对应单次修改的影响条数。 fetchsize：Integer类型。用于设置数据库连接所创建statement的默认fetchsize。默认值为0，表示一次获取所有结果。与defaultRowFetchSize功能等价，如果同时设置，以fetchsize为准。 reWriteBatchedInserts：Boolean类型。缺省值为false。批量导入时，该参数设置为true，可将N条插入语句合并为一条：insert into TABLE_NAME values(values1, ..., valuesN), ..., (values1, ..., valuesN)。使用该参数时，需设置batchMode=off。 unknownLength：Integer类型。默认为Integer.MAX_VALUE。某些GaussDB类型（例如TEXT）没有明确定义的长度，当通过ResultSetMetaData.getColumnDisplaySize和ResultSetMetaData.getPrecision等函数返回关于这些类型的数据时，此参数指定未知长度类型的长度。 uppercaseAttributeName：Boolean类型。默认值为false不开启，为true时开启。该参数开启后会将获取元数据的接口的查询结果转为大写。适用场景为数据库中存储元数据全为小写，但要使用大写的元数据作为出参和入参。 涉及到的接口请参见：java.sql.DatabaseMetaData、java.sql.ResultSetMetaData。 defaultRowFetchSize：Integer类型。确定一次fetch在ResultSet中读取的行数。限制每次访问数据库时读取的行数可以避免不必要的内存消耗，从而避免OutOfMemoryException。缺省值是0，意味着ResultSet中将一次获取所有行。本参数不允许设置为负值。 binaryTransfer：Boolean类型。使用二进制格式发送和接收数据，默认值为false。 binaryTransferEnable：String类型。启用二进制传输的类型列表，以逗号分隔。OID编号和名称二选一，例如：binaryTransferEnable=Integer4_ARRAY,Integer8_ARRAY。比如：OID名称为BLOB，编号为88，可以进行如下配置：binaryTransferEnable=BLOB 或 binaryTransferEnable=88。 binaryTransferDisable：String类型。禁用二进制传输的类型列表，以逗号分隔。OID编号和名称二选一。覆盖binaryTransferEnable的设置。 blobMode：String类型。用于设置setBinaryStream方法为不同类型的数据赋值，设置为on时表示为blob类型数据赋值，设置为off时表示为bytea类型数据赋值，默认为on。建议从Oracle、Mysql迁移的系统将该值设定为on，从Postgresql迁移的系统设定为off。 socketFactory：String类型。用于创建与服务器socket连接的类的名称。该类必须实现接口“javax.net.SocketFactory”，并定义无参或单String参数的构造函数。 socketFactoryArg：String类型。此值是上面提供的socketFactory类的构造函数的可选参数，不推荐使用。 receiveBufferSize：Integer类型。该值用于设置连接流上的SO_RCVBUF。 sendBufferSize：Integer类型。该值用于设置连接流上的SO_SNDBUF。 preferQueryMode：String类型。共有4种："extended"、 "extendedForPrepared"、"extendedCacheEverything"、"simple"。用于指定执行查询的模式，simple模式会excute，不parse和bind；extended模式会bind和excute；extendedForPrepared模式为prepared statement扩展使用；extendedCacheEverything模式会缓存每个statement。 targetServerType：String类型。该参数识别主备数据节点是通过查询URL连接串中，数据节点是否允许写操作来实现的，默认为"any"。共有五种："any"、"master"、"slave"、"preferSlave"、"clusterMainNode"。 master则尝试连接到URL连接串中的主节点，如果找不到将抛出异常。 slave则尝试连接到URL连接串中的备节点，如果找不到将抛出异常。 preferSlave则尝试连接到URL连接串中的备数据节点（如果有可用节点），否则连接到主数据节点。 any则尝试连接URL连接串中的任何一个数据节点。 clusterMainNode则尝试连接到URL串中的主节点或首备节点（容灾主节点），如果找不到将抛出异常。 priorityServers：Integer类型。此值用于指定url上配置的前n个节点作为主数据库实例被优先连接。默认值为NULL。该值为数字，大于0且小于url上配置的DN数量。用于流式容灾场景。 例如：jdbc:gaussdb://host1:port1,host2:port2,host3:port3,host4:port4,/database?priorityServers=2。即表示host1与host2为主数据库实例节点，host3与host4为容灾数据库实例节点。 forceTargetServerSlave：Boolean类型。此值用于控制是否开启强制连接备机功能，并在数据库实例发生主备切换时，禁止已存在的连接在升主备机上继续使用。默认值为false，表示不开启强制连接备机功能。true，表示开启强制连接备机功能。 traceInterfaceClass：String类型。默认值为NULL，用于获取traceId的实现类。值是实现获取traceId方法接口com.huawei.gaussdb.jdbc.log.Tracer的实现类的完整限定类名。 use_boolean：Boolean类型。用于设置extended模式下setBoolean方法绑定的oid类型，默认为false，绑定int2类型。设置为true则绑定Boolean类型。 allowReadOnly：Boolean类型。用于设置是否允许连接开启只读模式，默认为true，允许设置只读模式。设置为false则禁用只读模式，此时调用connection.setReadOnly(true)不生效，仍可以修改数据。 TLSCiphersSupperted：String类型。用于设置支持的TLS加密套件，默认为TLS_DHE_RSA_WITH_AES_128_GCM_SHA256,TLS_DHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384。 stripTrailingZeros：Boolean类型。默认值为false，设置为true则去除numeric类型后的0，仅对ResultSet.getObject(int columnIndex)生效。 enableTimeZone：Boolean类型。默认值为true，用于指定是否启用服务端时区设置，true表示获取JVM时区指定数据库时区，false表示使用数据库时区。 loadBalanceHosts：Boolean类型。在默认模式下（禁用），默认顺序连接URL中指定的多个主机。如果启用，则使用洗牌算法从候选主机中随机选择一个主机建立连接。集中式环境下，如果使用此参数需要保证业务中没有写操作。 compatibilityTags：String类型。默认为NULL，用于将驱动的部分特性恢复到早期版本，以确保前向兼容。可配置一个或多个tag，每个tag代表开启对应的前向兼容性特性，不同tag之间用“,”隔开。一般不建议使用该参数，除非有明确的前向兼容问题。目前支持的tag如下： typeMapInitNull：使用该tag后，兼容驱动早期版本的行为，java.sql.Connection中typeMap的初始值为NULL，如果不使用该tag，初始值为空Map。 parseCandidatesByDomain：Boolean类型。默认值false，用于指定是否根据域名获得备节点。true表示启用，false表示禁用。开启后需要将url中的host信息配置成域名+端口的形式，驱动会基于域名获得IP，生成备节点集合，并可以配合autoBalance参数做负载均衡，或者配合targetServerType参数做自动寻主。 primaryDomains：Integer类型。用于指定url上配置的前n个域名作为主数据库实例被优先连接。默认为0，表示关闭。需要将parseCandidatesByDomain参数设置为true时才能生效，大于0表示开启，且取值要小于url上配置的域名数量。将url中的域名拆分成两个分组，前一个分组为主数据库实例，后一个分组为备数据库实例。发生主备切换后，两个分组交换位置，前一个分组为备数据库实例，后一个分组为主数据库实例。适用于流式容灾和Dorado双数据库实例场景。 例如：jdbc:gaussdb://domain1:port1,domain2:port2,domain3:port3,domain4:port4/database?parseCandidatesByDomain=true&primaryDomains=2，即表示domain1和domain2对应主数据库实例，优先连domain1和domain2对应的IP。如果发生主备切换，将domain3和domain4标记为主数据库实例，优先对domain3和domain4建立连接。 priorityDomains：Integer类型。用于指定url上配置的前n个域名作为优先连接的域名。默认为0，表示关闭，需要将parseCandidatesByDomain参数设置为true时才能生效，大于0表示开启，且取值要小于url上配置的域名数量，如果配置了primaryDomains，则需要小于primaryDomains配置的数值。 例如：jdbc:gaussdb://domain1:port1,domain2:port2,domain3:port3,domain4:port4/database?parseCandidatesByDomain=true&primaryDomains=2&priorityDomains=1，即表示domain1和domain2对应主数据库实例，但是优先连domain1对应的IP，domain2是备用域名，只有domain1不可连后才尝试连domain2。如果发生主备切换，将domain3和domain4标记成主数据库实例，但是优先连domain3对应的IP，domain3不可以连后才尝试连domain4对应的IP。 refreshDomainResolveTime：Integer类型。默认为10，单位是秒，最小值为1，最大值为2147483647。代表域名解析结果的刷新周期，需要将parseCandidatesByDomain参数设置为true时才能生效，生效后会将url中涉及的域名解析刷新时间设置为指定的数值，并在异步线程中定时更新域名解析结果。注意驱动仅通过应用所在环境的DNS服务获取域名解析结果，为保障域名绑定的变更被驱动及时感知，需要应用所在环境的DNS服务保障域名绑定关系变更后能够及时生效。 oracleCompatible：String类型。默认为false。用户控制驱动接口的A兼容特性。有以下几种取值： 设置为true或on：表示开启驱动侧所有的A兼容特性。 设置为false或off：表示关闭驱动侧所有的A兼容特性。 设置为"tag1,tag2,tag3"：配置一个或多个tag，tag之间用逗号隔开，表示开启驱动侧部分的A兼容特性，每个tag对应一个A兼容特性。 当前支持的tag有： getProcedureColumns：DatabaseMetaData#getProcedureColumns接口的行为兼容A行为。 getCallableStatementResults：开启后，调用CallableStatement的getLong、getInt、getShort、getByte四个接口时与A模式数据库保持一致。在注册出参类型为java.sql.Types#NUMERIC时，调用CallableStatement的getLong、getInt、getShort、getByte接口，能够正常接收out的值，只有out数值超过java数值，数据类型取值范围会提示SQLException异常。 batchInsertAffectedRows：reWriteBatchedInserts开启后，执行批量插入接口Statement#executeBatch的返回结果兼容A行为。 printSqlInLog：Boolean类型。默认值为true，用于指定异常信息中或日志中是否输出sql语句，true表示启用，false表示禁用。 useGsClobBlobClass：Boolean类型。默认为false，表示关闭。 设置为true开启后，使用java.sql.ResultSet#getObject接口获取获取clob字段时会返回PGClob类型的对象，获取blob字段时会返回PGBlob类型的对象。通过元数据接口java.sql.ResultSetMetaData#getColumnClassName获取clob字段的类型名称会返回java.sql.Clob，获取blob字段的类型名称时会返回java.sql.Blob。 设置为false关闭后，使用java.sql.ResultSet#getObject接口获取获取clob字段时会返回PGClob类型的对象，获取blob字段时会返回byte[]类型的对象。通过元数据接口java.sql.ResultSetMetaData#getColumnClassName获取clob字段的类型名称会返回java.sql.CLOB，获取blob字段的类型名称时会返回java.sql.BLOB。 executeUpdateQueryable：Boolean类型。默认值为false，用于指定executeUpdate方法是否开启执行DQL语句，true表示启用，false表示禁用。开启后，executeUpdate方法执行DQL语句的返回值为-1，能够得到结果集。不推荐开启此参数。 dbMonitor：Boolean类型。默认值为false，用于指定JDBC是否开启连接监控功能。true表示启用，false表示禁用。 连接监控功能支持监控JDBC端以下指标：应用开启连接的次数、关闭连接的次数、连接异常断开的次数、数据库访问量、客户端机器CPU的使用率、内存的使用率、上下行传输速率、应用端到数据库链路之间的网络时延、抖动、丢包率。 将dbMonitor设置为true，loggerLevel设置为debug，loggerFile设置为filePath，可将客户端的连接监控输出到日志文件filePath中，具体示例见示例4 数据库连接监控功能使用。 enableStreamingQuery：Boolean类型，默认值为false，用于控制是否开启流式读功能。true表示开启，false表示关闭。将该参数值设置为true，同时使用statement.setFetchSize(Integer.MIN_VALUE)或者statement.enableStreamingResults()，表示开启流式读功能。 流式读：读取数据时，一次获取全部，发送到客户端socket缓冲区中，缓冲区占满则暂停，有空余则继续向缓冲区中发送数据，同时JVM逐行从缓冲区中读取数据。优势是处理结果快，不会造成JVM内存溢出。劣势是只能向后遍历，数据处理完毕之前或者statement关闭之前，当前连接不能执行其他操作，具体示例见示例部分的示例2。 yearIsDateType：Boolean类型。默认值为true，表示开启。 设置为true开启后，使用java.sql.ResultSet#getObject接口获取year数据类型字段时会返回Date类型的对象，使用java.sql.ResultSet#getString接口获取数据时会返回yyyy-mm-dd格式的日期字符串，使用java.sql.ResultSet#getInt/getLong/getShort接口获取数据会返回年份数值。 设置为false关闭后，使用java.sql.ResultSet#getObject接口获取year数据类型字段时会返回Integer类型的对象，使用java.sql.ResultSet#getString接口获取数据时返回年份的字符串，使用java.sql.ResultSet#getInt/getLong/getShort接口获取数据会返回年份数值。 enableALT：Boolean类型。默认值为false，表示关闭。如果要开启ALT功能，需要同时配置enableALT和gns才可以生效。 设置为true后，计划内ALT功能开启连接数据库时会先与GNS建立连接，这个数据库实例后续连接DN时不会再与GNS重新建立连接。在数据库实例状态发生变化时，GNS会向JDBC发送FAN消息。 设置为false后，计划内ALT功能关闭，JDBC不会和GNS建立连接。 altLevel：Char类型。默认值为空，表示ALT只开启数据库实例状态通知功能。 设置为C时，表示开启加速连接和快速断连功能，在与DN建立新连接时会根据数据库实例连接管理器中各节点的主备状态对DN列表进行排序，加速新连接建立的过程。在收到数据库实例节点DOWN的状态通知消息后，主动关闭数据库实例连接管理器中管理的连接。 设置为P时，表示开启加速连接、快速断连以及计划内维护功能。在与DN建立新连接时会根据数据库实例连接管理器中各节点的主备状态对DN列表进行排序，加速新连接建立的过程。在收到数据库实例节点DOWN的状态通知消息后，主动关闭数据库实例连接管理器中管理的连接。在收到数据库实例节点进入计划内维护的消息后，会先将数据库实例连接管理器中所有连接进行事务排干，待数据库实例计划内维护完成后，重新连接DN，恢复连接的GUC参数，保证连接可用。 gns：String类型。默认值为空。表示GNS的IP地址和端口列表。在JDBC连接GNS时，会按照随机顺序对GNS列表依次进行连接，直到成功和某一个GNS建立连接、连接失败或超时。 setFloat：Boolean类型，表示调用setFloat或者setObject指定类型为float时，传递给内核的Oid是否为float4的Oid。true表示开启，传递给内核的Oid为float8，false表示关闭，传递给内核的Oid为float4，默认为false。 user 数据库用户。 password 数据库用户的密码。 uppercaseAttributeName参数开启后，如果数据库中有小写、大写和大小写混合的元数据，只能查询出小写部分的元数据，并以大写的形式输出，使用前请务必确认元数据的存储是否全为小写以避免数据出错。

参数 表1 SQLGetDiagRec参数 关键字 参数说明 HandleType 句柄类型标识符，它说明诊断所要求的句柄类型。必须为下列值之一： SQL_HANDLE_ENV SQL_HANDLE_DBC SQL_HANDLE_STMT SQL_HANDLE_DESC Handle 诊断数据结构的句柄，其类型由HandleType来指出。如果HandleType是SQL_HANDLE_ENV，Handle可以是共享的或非共享的环境句柄。 RecNumber 指出应用从查找信息的状态记录。状态记录从1开始编号。 SQLState 输出参数：指向缓冲区的指针，该缓冲区存储着有关RecNumber的五字符的SQLSTATE码。 NativeErrorPtr 输出参数：指向缓冲区的指针，该缓冲区存储着本地的错误码。 MessageText 指向缓冲区的指针，该缓冲区存储着诊断信息文本串。 BufferLength MessageText的长度。 TextLengthPtr 输出参数：指向缓冲区的指针，返回MessageText中的字节总数。如果返回字节数大于BufferLength，则MessageText中的诊断信息文本被截断成BufferLength减去NULL结尾字符的长度。

原型 1 2 3 4 5 6 7 8 SQLRETURN SQLGetDiagRec(SQLSMALLINT HandleType SQLHANDLE Handle, SQLSMALLINT RecNumber, SQLCHAR *SQLState, SQLINTEGER *NativeErrorPtr, SQLCHAR *MessageText, SQLSMALLINT BufferLength SQLSMALLINT *TextLengthPtr);

注意事项 SQLGetDiagRec不发布自己的诊断记录。用下列返回值来报告自己的执行结果： SQL_SUCCESS：函数成功返回诊断信息。 SQL_SUCCESS_WITH_INFO：MessageText太小以致不能容纳所请求的诊断信息。没有诊断记录生成。 SQL_INVALID_HANDLE：由HandleType和Handle所指出的句柄是不合法句柄。 SQL_ERROR：RecNumber小于等于0或BufferLength小于0。 如果调用ODBC函数返回SQL_ERROR或SQL_SUCCESS_WITH_INFO，可调用SQLGetDiagRec返回诊断信息SQLSTATE值，如表2 SQLSTATE值所示。 表2 SQLSTATE值 SQLSATATE 错误 描述 HY000 一般错误 未定义特定的SQLSTATE所产生的错误。 HY001 内存分配错误 驱动程序不能分配所需要的内存来支持函数的执行或完成。 HY008 取消操作 调用SQLCancel取消执行语句后，依然在StatementHandle上调用函数。 HY010 函数系列错误 在为执行中的所有数据参数或列发送数据前就调用了执行函数。 HY013 内存管理错误 不能处理函数调用，可能由当前内存条件差引起。 HYT01 连接超时 数据源响应请求之前，连接超时。 IM001 驱动程序不支持此函数 调用了StatementHandle相关的驱动程序不支持的函数。

DBE_SQL_UTIL.create_abort_sql_patch create_abort_sql_patch是用于创建避险SQL PATCH的接口函数，返回执行是否成功，如表1所示。 限制：仅初始用户、sysadmin、opradmin和monadmin用户有权限调用。 表1 DBE_SQL_UTIL.create_abort_sql_patch入参和返回值列表 参数 类型 描述 patch_name IN name PATCH名称。 unique_sql_id IN bigint 查询全局唯一id。 description IN text PATCH的备注，默认值为NULL。 enabled IN bool PATCH是否生效，默认值为true。 result OUT bool 执行是否成功。 父主题： DBE_SQL_UTIL Schema

接口介绍 高级功能包DBE_MATCH支持的所有接口请参见表1。 表1 DBE_MATCH 接口名称 描述 DBE_MATCH.EDIT_DISTANCE_SIMILARITY 比较两个字符串的差距（删除、新增、变换的最小步骤），并归一化到0-100（100表示完全一致，0表示完全不一致）。 DBE_MATCH.EDIT_DISTANCE_SIMILARITY 比较两个字符串的差距(删除、新增、变换的最小步骤)，并归一化到0-100（100表示完全一致，0表示完全不一致）,DBE_MATCH.EDIT_DISTANCE_SIMILARITY函数原型为： 1 2 3 4 DBE_MATCH.EDIT_DISTANCE_SIMILARITY( str1 IN text, str2 IN text )returns integer ; 表2 DBE_MATCH.EDIT_DISTANCE_SIMILARITY接口参数说明 参数 描述 str1 第一个字符串，如果为null，直接输出0。 str2 第二个字符串，如果为null，直接输出0。

PG_CAST PG_CAST系统表存储数据类型之间的转换关系。 表1 PG_CAST字段 名称 类型 描述 oid oid 行标识符（隐含属性，必须明确选择）。 castsource oid 源数据类型的OID。 casttarget oid 目标数据类型的OID。 castfunc oid 转换函数的OID。如果为零表明不需要转换函数。 castcontext "char" 源数据类型和目标数据类型间的转换方式： 'e'：表示只能进行显式转换（使用CAST或::语法）。 'i'：表示能进行隐式转换。 'a'：表示类型间同时支持隐式和显式转换。 castmethod "char" 转换方法： 'f'：使用castfunc字段中指定的函数进行转换。 'b'：类型间是二进制强制转化，不使用castfunc。 父主题： 其他系统表

enable_rls_match_index 参数说明：控制是否支持在行级访问控制特性使用场景中，基于目标谓词条件对基表执行索引扫描。目标场景为：基表设置并开启了RLS（Row Level Security）策略，查询谓词中包含unleakproof类型系统函数或like操作符。 取值范围：布尔型。 on：支持目标场景下的基表索引扫描。 off：不支持目标场景下的基表索引扫描。 默认值：off 设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。 设置建议：设置为默认值。若业务热点查询语句为目标场景，且基表行级访问策略数量较少，可打开该开关以显著提升查询性能。 该参数的修改，会影响目标场景下执行计划的生成，可通过重连、创建操作符等方式手动使缓存计划失效。 该参数开启后，会影响到位图扫描算子的生成，RLS策略谓词将被插入到Recheck过滤条件中；因此，在该算子切换为lossy模式且RLS策略数目较多时，会对性能产生一定影响。

enable_tde 参数说明：透明数据加密功能开关。创建加密表前需要将此参数置为on，并且通过tde_key_info参数配置密钥信息。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型。 on：开启透明数据加密功能。 off：关闭透明数据加密功能。 默认值：off 设置此参数为on，需要保证tde_key_info参数中密钥信息配置正确，并且密钥服务可以正常访问，否则会导致数据库无法正常启动。 设置此参数为on并且创建了加密表后，如果再将此参数设置为off会导致已有加密表的数据无法进行加解密，从而导致数据库异常。

block_encryption_mode 参数说明：aes_encrypt和aes_decrypt函数进行加解密时使用的块加密模式。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：枚举类型，有效值为aes-128-cbc, aes-192-cbc，aes-256-cbc，aes-128-cfb1，aes-192-cfb1，aes-256-cfb1，aes-128-cfb8，aes-192-cfb8，aes-256-cfb8，aes-128-cfb128，aes-192-cfb128，aes-256-cfb128，aes-128-ofb，aes-192-ofb，aes-256-ofb。其中aes表示加/解密算法，128/192/256表示密钥长度（单位：bit），cbc/cfb1/cfb8/cfb128/ofb表示块加/解密模式。 默认值：aes-128-cbc

elastic_search_ip_addr 参数说明：Elastic Search系统IP地址 ，使用https协议格式为：https://ip:port:username；使用http协议格式为：http://ip:port。其中，ip为Elastic Search服务器的IP，port为Elastic Search HTTP通信的侦听端口，范围为9200 - 9299，username为用户在Elastic Search注册账号所使用的用户名，初始用户为elastic使用https协议需要配置相关证书，详见《安全加固指南》中“统一审计“章节。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：字符串。 默认值：''

tde_index_default_encrypt 参数说明：创建索引时，如果开启本参数，并且索引的基表是加密表，则数据库自动将索引设置为加密索引，并自动为索引复制基表的加密算法，密钥等加密参数，对索引中的数据先加密再存储。 参数类型：布尔型 参数单位：无 取值范围： on：自动对加密表的索引设置加密参数。 off：不自动对加密表的索引设置加密参数。 默认值：off 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：建议设置为默认值。

use_elastic_search 参数说明：使能统一审计发送日志至Elastic Search系统, enable_security_policy打开且本参数打开后，统一审计日志会通过http(https)传递至Elastic Search系统（默认使用https安全协议）。此参数打开后需要保证elastic_search_ip_addr对应的es服务可正常连通，否则进程启动失败。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型。 on：使能统一审计日志发送至Elastic Search。 off：关闭统一审计日志发送至Elastic Search。 默认值：off

plat_compat_allow_public_key_retrieval 参数说明：M-Compatibility模式数据库行为配置项。该参数是用来控制是否允许客户端RSA Public key的开关，默认关闭。 参数类型：布尔型 on表示内核允许客户端请求RSA Public key，支持密码通过RSA加密传输。 off表示不允许客户端请求RSA Public key。 参数单位：无 默认值：off 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：选择RSA连接时，参数设为on，并将SSL设置为off。

enable_innertool_cert 参数说明：用于控制内部工具使用证书认证。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 on：表示内部工具使用证书认证。 off：表示内部工具不使用证书认证。 默认值：off 此参数必须与参数ssl开关同时打开才能生效。 此开关打开使用的证书默认配置的是$GAUSSHOME/share/sslcert/gsql目录下的证书，证书的Common Name必须与初始用户相同，否则认证失败。 此参数生效后，初始用户使用证书认证，其他用户则需要使用密码方式认证。 此参数打开，允许初始用户使用证书认证方式远程连接数据库。