连接参数参考
info参数连接的所有属性名称对大小写敏感。常用的属性如表1所示。
|
属性名称 |
属性说明 |
属性值 |
|---|---|---|
|
PGDBNAME |
表示数据库名称（URL中无需配置该参数，自动从Properties文件中解析）。 |
属性类型：String |
|
PGHOST |
主机IP地址。 |
属性类型：String |
|
PGPORT |
主机端口号。 |
属性类型：Integer |
|
user |
表示创建连接的数据库用户。 |
属性类型：String |
|
password |
表示数据库用户的密码。 |
属性类型：String |
|
driverInfoMode |
控制驱动描述信息的输出模式。 |
属性类型：String 取值范围：postgresql、gaussdb。
默认值：postgresql |
|
loggerLevel |
指定日志记录级别。 |
属性类型：String 取值范围：目前支持4种级别：OFF、INFO、DEBUG、TRACE。
默认值：该属性不设置则为空，与设置为INFO等效。 |
|
loggerFile |
用于指定日志输出路径（目录和文件名）。此参数已废弃，不再生效。 如需指定日志输出路径可通过 java.util.logging 属性文件或系统属性进行配置。 |
属性类型：String |
|
logger |
表示JDBC Driver要使用的日志输出框架。JDBC Driver支持对接用户应用程序使用的日志输出框架。 |
属性类型：String 取值范围：Slf4JLogger
|
|
allowEncodingChanges |
设置该参数值为true进行字符集类型更改，配合参数characterEncoding设置字符集，二者使用“&”分隔。characterEncoding取值范围为UTF8、GBK、LATIN1、GB18030。例：allowEncodingChanges=true&characterEncoding=UTF8。 |
属性类型：Boolean 取值范围：
默认值：false |
|
currentSchema |
设置当前连接的schema，在search-path中指定要设置的schema。如果schema名包含除字母、数字、下划线之外的特殊字符，建议在schema名上加引号，注意schema名大小写敏感。如需配置多个schema，要用逗号（,）进行分隔，包含特殊字符的schema也需要加引号处理。 例如：currentSchema=schema_a,"schema-b","schema/c" |
属性类型：String 缺省：如果未设置，则默认schema为连接使用的用户名。 |
|
hostRecheckSeconds |
JDBC尝试连接主机后会保存主机状态：连接成功或连接失败。在hostRecheckSeconds时间内保持可信，超过则状态失效。 |
属性类型：Integer 属性单位：s 取值范围：0 ~ 2147483647 默认值：10 |
|
ssl |
表示以SSL方式连接数据库。 ssl=true可支持NonValidatingFactory通道和使用证书的方式： 1、NonValidatingFactory通道需要配置用户名和密码，同时将SSL设置为true。 2、配置客户端证书、密钥、根证书，将SSL设置为true。 |
属性类型：Boolean 取值范围：
默认值：该属性不设置则为空，与false等效。 |
|
sslmode |
SSL认证方式。 |
属性类型：String 取值范围：disable、allow、prefer、require、verify-ca、verify-full。
默认值：该属性不设置则为空，与require等效。 |
|
sslcert |
提供客户端证书文件的完整路径。证书类型为End Entity。 |
属性类型：String 默认值：该属性不设置则为空，读取用户根目录。 |
|
sslkey |
提供密钥文件的完整路径，使用时需将该密钥转换为DER格式。 openssl pkcs8 -topk8 -outform DER -in client.key -out client.key.pk8 -nocrypt |
属性类型：String 默认值：该属性不设置则为空，读取用户根目录。 |
|
sslrootcert |
SSL根证书的文件名。根证书的类型为CA。 |
属性类型：String 默认值：该属性不设置则为空，读取用户根目录。 |
|
sslpassword |
SSL密码，提供给ConsoleCallbackHandler使用。 |
属性类型：String |
|
sslpasswordcallback |
SSL密码提供者的类名。 |
属性类型：String 默认值：该属性不设置则为空。 |
|
sslfactory |
指定SSLSocketFactory在建立SSL连接时用的类名。 |
属性类型：String 默认值：该属性不设置则为空。 |
|
sslprivatekeyfactory |
提供的值是实现私钥解密方法的接口org.postgresql.ssl.PrivateKeyFactory的实现类的完整限定类名。如果不提供，首先尝试默认的jdk私钥解密算法，如果无法解密，则使用org.postgresql.ssl.BouncyCastlePrivateKeyFactory，用户需要自己提供bcpkix-jdk15on.jar包，版本建议：1.65以上。 |
属性类型：String 默认值：该属性不设置则为空。 |
|
sslfactoryarg |
此值是sslfactory类的构造函数的可选参数（不推荐使用）。 |
属性类型：String 默认值：该属性不设置则为空。 |
|
sslhostnameverifier |
主机名验证程序的类名。接口实现javax.net.ssl.HostnameVerifier，默认使用com.huawei.opengauss.jdbc.ssl.PGjdbcHostnameVerifier。 |
属性类型：String 默认值：该属性不设置则为空，默认使用com.huawei.opengauss.jdbc.ssl.PGjdbcHostnameVerifier。 |
|
loginTimeout |
指建立数据库连接的等待时间。当url配置多IP时，若获取连接花费的时间超过此值，则连接失败，不再尝试后续IP。 loginTimeout时间包括connectTimeout和socketTimeoutInConnecting，计算方式为：loginTimeout=(connectTimeout+连接认证时间+初始化语句执行时间)*节点数量。
须知：
|
属性类型：Integer 属性单位：s（秒） 取值范围：0 ~ 2147483647。0表示已禁用，timeout不生效。 默认值：0 建议：配置后每次建连都会开启一个异步线程，在连接数较多的情况可能会导致客户端压力增大，如果业务确认需要设置此参数，在集中式环境下建议调整为max(connectTimeout, socketTimeoutInConnecting) * 节点数，防止在网络异常情况且第n个IP为主的情况下，无法连接。 |
|
connectTimeout |
用于连接服务器操作系统的超时值。如果连接到服务器操作系统花费的时间超过此值，则连接断开。当url配置多IP时，表示连接单个IP的超时时间。 |
属性类型：Integer 属性单位：s（秒） 取值范围：0 ~ 2147483647。0表示已禁用，timeout不生效。 默认值：0 |
|
socketTimeout |
用于socket读取操作的超时值。如果从服务器读取数据流所花费的时间超过此值，则连接关闭。如果不配置该参数，在数据库进程异常情况下，会导致客户端出现长时间等待，建议根据业务可以接受的SQL执行时间进行配置。
说明：
当JDBC侧触发超时且连接关闭时，其下发给数据库侧正在运行的业务会被强制终止。业务强制终止的能力受GUC参数check_disconnect_query控制，设置为on表示支持该能力，设置为off表示不支持该能力。 |
属性类型：Integer 属性单位：s（秒） 取值范围：0 ~ 2147483647。0表示已禁用，timeout不生效。 默认值：0 |
|
socketTimeoutInConnecting |
用于控制建连阶段socket读取操作的超时值。在建连阶段，如果从服务器读取数据流超过此阈值，则尝试查找下一个节点建连。 |
属性类型：Integer 属性单位：s（秒） 取值范围：0 ~ 2147483647 默认值：5 |
|
cancelSignalTimeout |
发送取消命令的消息本身可能会阻塞，用于控制取消命令的“connect超时”和“socket超时”。如果取消命令超过指定时间未响应，会中断该连接，减少占用客户端资源。 |
属性类型：Integer 属性单位：s（秒） 取值范围：0 ~ 2147483647 默认值：10 |
|
tcpKeepAlive |
TCP保活探测功能的控制开关。 |
属性类型：Boolean 取值范围：
默认值：false |
|
logUnclosedConnections |
客户端可能由于未调用Connection对象的close()方法而泄漏Connection对象。最终这些对象将被回收，并且调用finalize()方法。 |
属性类型：Boolean 取值范围：
默认值：false |
|
assumeMinServerVersion（废弃） |
该参数设置要连接的服务器版本。 如assumeMinServerVersion高于或者等于9.0，可以在建立连接时减少相关包的发送，客户端不会发送请求将float精度设置为3（即维持原来设置的float精度2）。 |
属性类型：String 默认值：该属性不设置则为空。 |
|
ApplicationName |
设置正在使用连接的JDBC驱动的名称。通过在数据库主节点上查询pg_stat_activity表可以看到正在连接的客户端信息，JDBC驱动名称显示在application_name列。 |
属性类型：String 默认值：PostgreSQL JDBC Driver |
|
connectionExtraInfo |
表示驱动是否将当前驱动的部署路径、进程属主用户、url连接配置信息上报到数据库。 |
属性类型：Boolean 取值范围：
默认值：false |
|
autosave |
如果查询失败，指定驱动程序应该执行的操作。 |
属性类型：String 取值范围：always、never、conservative。
默认值：never |
|
protocolVersion |
连接协议版本号。 |
属性类型：Integer 取值范围：目前仅支持1和3。
默认值：该属性不设置则为空，与设置为3等效。 |
|
prepareThreshold |
该值决定PreparedStatement对象在执行多少次以后使用服务端已经解析好的statement。
说明：
不建议通过JDBC，并且使用prepareStatement的方式执行涉及密码的语句（例如：CREATE USER user_name WITH PASSWORD '********'；），原因是执行达到prepareThreshold指定次数时，数据库将SQL语句进行缓存，基于安全因素不会将密码进行缓存，该prepareStatement再次执行时会报错（Password must contain at least 8 characters.）。 |
属性类型：Integer 取值范围：0 ~ 2147483647 默认值：5。意味着在执行同一个PreparedStatement对象时，在第五次及以上执行时不再向服务端发送parse消息对statement进行解析，而使用之前在服务端已经解析好的statement。 |
|
preparedStatementCacheQueries |
确定每个连接中缓存preparedStatement对象所生成query的最大数量。 |
属性类型：Integer 取值范围：0 ~ 2147483647。0表示禁用缓存。 默认值：256。若在prepareStatement()调用中使用超过256个不同的查询，则最近最少使用的查询缓存将被丢弃。 建议：根据业务需要进行调整。配合prepareThreshold使用。 |
|
preparedStatementCacheSizeMiB |
确定每个连接中缓存preparedStatement对象所生成query的最大值。 |
属性类型：Integer 属性单位：MB 取值范围：0 ~ 2147483647。0表示禁用缓存。 默认值：5。若缓存了超过5MB的query，则最近最少使用的查询缓存将被丢弃。 |
|
databaseMetadataCacheFields |
指定每个连接可缓存的字段的最大个数。 |
属性类型：Integer 取值范围：0 ~ 2147483647。0表示禁用缓存。 默认值：65536 |
|
databaseMetadataCacheFieldsMiB |
指定每个连接可缓存的字段的最大值。 |
属性类型：Integer 属性单位：MB 取值范围：0 ~ 2147483647。0表示禁用缓存。 默认值：5 |
|
stringtype |
指定调用java.sql.PreparedStatement#setString方法时传给数据库的参数类型。 |
属性类型：String 取值范围：unspecified、varchar。
默认值：varchar |
|
batchMode |
表示是否使用batch模式连接。
说明：
配置batchMode=on时，执行批量插入/批量修改操作，每一列的数据类型以第一条数据指定的类型为准，若数据类型混用可能会导致报错或者插入的数据异常。 |
属性类型：String 取值范围：
默认值：on |
|
fetchsize |
用于设置数据库连接所创建statement的默认fetchsize。 确定一次fetch在ResultSet中读取的行数，与defaultRowFetchSize功能等价。如果fetchsize和defaultRowFetchSize同时设置，以fetchsize为准。 |
属性类型：Integer 取值范围：0 ~ 2147483647 默认值：0。表示一次从数据库获取所有结果。 建议：用户根据自身的业务查询数据数量和客户端机器内存情况来配置此参数，设置fetchsize时要关闭自动提交(autocommit=false)模式，否则会导致fetchsize无法生效。 |
|
defaultRowFetchSize |
确定一次fetch在ResultSet中读取的行数。限制每次访问数据库时读取的行数可以避免不必要的内存消耗，从而避免OutOfMemoryException。 |
属性类型：Integer 取值范围：0 ~ 2147483647 默认值：0。表示一次从数据库获取所有结果。 |
|
reWriteBatchedInserts |
表示批量插入时，是否重写SQL语句。使用该参数时，要求设置batchMode=off。 |
属性类型：Boolean 取值范围：
默认值：false |
|
unknownLength |
某些GaussDB类型（例如TEXT）没有明确定义的长度，当通过ResultSetMetaData.getColumnDisplaySize和ResultSetMetaData.getPrecision等函数返回关于这些类型的数据时，此参数指定未知长度类型的长度。 |
属性类型：Integer 取值范围：0 ~ 2147483647 默认值：Integer.MAX_VALUE |
|
uppercaseAttributeName |
该属性开启后会将获取元数据的接口的查询结果转为大写。主要适用场景为数据库中存储元数据全为小写，但要使用大写的元数据作为出参和入参。 涉及到的接口请参见：java.sql.DatabaseMetaData、java.sql.ResultSetMetaData。
说明：
uppercaseAttributeName参数开启后，如果数据库中有小写、大写和大小写混合的元数据，只能查询出小写部分的元数据，并以大写的形式输出，使用前请务必确认元数据的存储是否全为小写以避免数据出错。 |
属性类型：String 取值范围：
默认值：false |
|
binaryTransfer |
是否启用二进制格式发送和接收数据。 |
属性类型：Boolean 取值范围：
默认值：false |
|
binaryTransferEnable |
启用二进制传输的类型列表。以逗号分隔，例如：binaryTransferEnable=Integer4_ARRAY,Integer8_ARRAY。 OID编号和名称二选一。比如：OID名称为BLOB，编号为88，可以进行如下配置：binaryTransferEnable=BLOB 或 binaryTransferEnable=88。 |
属性类型：String 默认值：该属性不设置则为空。 |
|
binaryTransferDisable |
禁用二进制传输的类型列表。以逗号分隔，OID编号和名称二选一。如果binaryTransferDisable与binaryTransferEnable有相同的value，则会禁用。 |
属性类型：String 默认值：该属性不设置则为空。 |
|
blobMode |
用于设置setBinaryStream()方法为不同类型的数据赋值。建议从A、B迁移的系统将该值设定为on，从PG迁移的系统设定为off。 |
属性类型：String 取值范围：
默认值：on |
|
socketFactory |
用于创建与服务器socket连接的类的名称。该类必须实现接口“javax.net.SocketFactory”，并定义无参或单String参数的构造函数。 |
属性类型：String |
|
socketFactoryArg |
此值是上面提供的socketFactory类的构造函数的可选参数，不推荐使用。 |
属性类型：String |
|
receiveBufferSize |
该值用于设置连接流上的SO_RCVBUF。 |
属性类型：Integer 属性单位：字节 取值范围：-1 ~ 2147483647 默认值：-1。表示不设置缓冲区大小。 |
|
sendBufferSize |
该值用于设置连接流上的SO_SNDBUF。 |
属性类型：Integer 属性单位：字节 取值范围：-1 ~ 2147483647 默认值：-1。表示不设置缓冲区大小。 |
|
preferQueryMode |
用于指定执行查询的模式。 |
属性类型：String 取值范围：simple、extended、 extendedForPrepared、extendedCacheEverything。
默认值：extended |
|
targetServerType |
该参数识别主备数据节点是通过查询URL连接串中，数据节点是否允许写操作来实现的。 |
属性类型：String
取值范围：any、master、slave、preferSlave、clusterMainNode。
默认值：any 查询语句：select local_role, db_state from pg_stat_get_stream_replications(); 建议：有写操作的业务建议配置master，以保证主备切换后能正常连接主节点，但是要注意在主备倒换过程中备机没有完全升主的时候无法正常建连，导致业务语句无法正常执行。 |
|
priorityServers |
此值用于指定url上配置的前n个节点作为主数据库实例被优先连接。应用于流式容灾场景。 例如：jdbc:opengauss://host1:port1,host2:port2,host3:port3,host4:port4/database?priorityServers=2。即表示host1与host2为主数据库实例节点，host3与host4为容灾数据库实例节点。 |
属性类型：Integer 取值范围：大于0且小于url上配置的DN数量。 默认值：NULL |
|
forceTargetServerSlave |
此值用于控制是否开启强制连接备机功能，并在数据库实例发生主备切换时，禁止已存在的连接在升主备机上继续使用。 |
属性类型：Boolean 取值范围：
默认值：false |
|
traceInterfaceClass |
获取traceId方法接口com.huawei.opengauss.jdbc.log.Tracer的实现类的完整限定类名。 |
属性类型：String 默认值：NULL |
|
use_boolean |
设置extended模式下setBoolean()方法绑定的oid类型。 |
属性类型：Boolean 取值范围：
默认值：false |
|
allowReadOnly |
设置是否允许连接开启只读模式。 |
属性类型：Boolean 取值范围：
默认值：true |
|
TLSCiphersSupperted |
设置支持的TLS加密套件。 |
属性类型：String 默认值：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 |
设置是否去除numeric类型后的0，仅对ResultSet.getObject(int columnIndex)生效。 |
属性类型：Boolean 取值范围：
默认值：false |
|
enableTimeZone |
用于指定是否启用客户端时区设置。 |
属性类型：Boolean 取值范围：
默认值：true |
|
loadBalanceHosts |
指定是否使用负载均衡功能。集中式环境下，如果使用此参数需要保证业务中没有写操作。 |
属性类型：Boolean 取值范围：
默认值：false |
