连接数据库

url

postgresql.jar数据库连接描述符。格式如下：

• jdbc:postgresql:database
• jdbc:postgresql://host/database
• jdbc:postgresql://host:port/database
• jdbc:postgresql://host:port/database?param1=value1&param2=value2
• jdbc:postgresql://host1:port1,host2:port2/database?param1=value1&param2=value2

info

数据库连接属性（所有属性大小写敏感）。常用的属性如下：

• PGDBNAME：String类型。表示数据库名称（URL中无需配置该参数，自动从URL中解析）。
• PGHOST：String类型。主机IP地址。同时支持IPv4和IPv6。详见示例。
• PGPORT：Integer类型。主机端口号。详见示例。
• user：String类型。表示创建连接的数据库用户。
• password：String类型。表示数据库用户的密码。
• enable_ce：String类型。其中enable_ce=1表示JDBC支持密态等值查询基本能力。
• refreshClientEncryption：String类型。其中refreshClientEncryption=1表示密态数据库支持客户端缓存刷新（默认值为1）。
• loggerLevel：String类型。目前支持4种级别：OFF、INFO、DEBUG、TRACE。设置为OFF关闭日志，设置为INFO、DEBUG和TRACE记录的日志信息详细程度不同。
• loggerFile：String类型。Logger输出的文件名。需要显示指定日志文件名，若未指定目录则生成在客户端运行程序目录。此参数已废弃，不再生效，如需使用可通过 java.util.logging 属性文件或系统属性进行配置。
• logger：String类型。表示JDBC Driver要使用的日志输出框架。JDBC Driver支持对接用户应用程序使用的日志输出框架。目前支持的第三方日志输出框架只有基于Slf4j-API的日志框架。具体使用方式，见日志管理
  1. 如果缺省或设置为JDK LOGGER，则JDBC Driver使用JDK LOGGER。
  2. 否则必须设置采用基于slf4j-API 第三方日志框架。
• allowEncodingChanges：Boolean类型。设置该参数值为“true”进行字符集类型更改，配合characterEncoding=CHARSET设置字符集，二者使用“&”分隔。characterEncoding取值范围为UTF8、GBK、LATIN1、GB18030，缺省值为false。
  说明：

  当连接到字符集为GB18030_2022的数据库时，characterEncoding设置为GB18030_2022不生效，会默认使用UTF8，需要设置为GB18030才能正常解析服务端的GB18030_2022字符。

• 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密码提供者的类名。缺省值：org.postgresql.ssl.jdbc4.LibPQFactory.ConsoleCallbackHandler。
• sslfactory：String类型。提供的值是SSLSocketFactory在建立SSL连接时用的类名。
• sslprivatekeyfactory：String类型。提供的值是实现私钥解密方法的接口org.postgresql.ssl.PrivateKeyFactory的实现类的完整限定类名。如果不提供，首先尝试默认的jdk私钥解密算法，如果无法解密，则使用org.postgresql.ssl.BouncyCastlePrivateKeyFactory，用户需要提供bcpkix-jdk15on.jar包，版本建议1.65以上。
• sslfactoryarg：String类型。此值是sslfactory类的构造函数的可选参数（不推荐使用）。
• sslhostnameverifier：String类型。主机名验证程序的类名。接口实现javax.net.ssl.HostnameVerifier，默认使用org.postgresql.ssl.PGjdbcHostnameVerifier。
• loginTimeout：Integer类型。指建立数据库连接的等待时间。超时时间单位为秒。当url配置多IP时，若获取连接花费的时间超过此值，则连接失败，不再尝试后续IP，缺省值为0。
• connectTimeout：Integer类型。用于连接服务器操作的超时值。如果连接到服务器花费的时间超过此值，则连接断开。超时时间单位为秒，值为0时表示已禁用，timeout不生效。当url配置多IP时，表示连接单个IP的超时时间，缺省值为0。
• socketTimeout：Integer类型。用于socket读取操作的超时值。如果从服务器读取所花费的时间超过此值，则连接关闭。超时时间单位为秒，值为0时表示已禁用，timeout不生效，缺省值为0。如果不配置该参数，在数据库进程异常情况下，会导致客户端出现长时间等待，建议根据业务可以接受的SQL执行时间进行配置。
• socketTimeoutInConnecting：Integer类型。用于控制建连阶段socket读取操作的超时值。如果建连时从服务器读取所花费的时间超过此值，则查找下一个节点建连。超时时间单位为秒，默认为5s。
• statementTimeout：Integer类型。用于控制connection中statement执行时间的超时值。如果statement执行时间超过此值，则取消该statement执行。超时时间单位为毫秒，值为0表示已禁用，timeout不生效，缺省值为0。
• driverInfoMode：String类型。用于控制驱动描述信息的输出模式。取值范围为postgresql、gaussdb，默认缺省值为postgresql，输出postgresql相关的驱动描述信息；设置为gaussdb时输出gaussdb相关的驱动描述信息。
• 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列。缺省值为PostgreSQL JDBC Driver。
• connectionExtraInfo：Boolean类型。表示驱动是否上报当前驱动的部署路径、进程属主用户到数据库。

  取值范围：true或false，默认值为false。设置connectionExtraInfo为true，JDBC驱动会将当前驱动的部署路径、进程属主用户、url连接配置信息上报到数据库中，记录在connection_info参数里，同时可以在PG_STAT_ACTIVITY中查询到。

• autosave：String类型。共有3种："always"、"never"、"conservative"。如果查询失败，指定驱动程序应该执行的操作。在autosave=always模式下，JDBC驱动程序在每次查询之前设置一个保存点，并在失败时回滚到该保存点。在autosave=never模式（默认）下，无保存点。在autosave=conservative模式下，每次查询都会设置保存点，但是只会在“statement XXX无效”等情况下回滚并重试，缺省值为never。
• protocolVersion：Integer类型。连接协议版本号，目前仅支持1和3。设置1时仅代表连接的是V1服务端。设置3时将采用MD5加密方式，需要同步修改数据库的加密方式，将GUC参数password_encryption_type设置为1，重启数据库生效后需要创建用MD5方式加密口令的用户。同时修改pg_hba.conf，将客户端连接方式修改为MD5，用新建用户进行登录（不推荐）。
  说明：

  MD5加密算法安全性低，存在安全风险，建议使用更安全的加密算法。

• prepareThreshold：Integer类型。控制parse语句何时发送。默认值是5。第一次parse一个SQL比较慢，后面再parse就会比较快，因为有缓存了。如果一个会话连续多次执行同一个SQL，在达到prepareThreshold次数以上时，JDBC将不再对这个SQL发送parse命令。
  说明：

  不建议通过JDBC，并且使用prepareStatement的方式执行涉及密码的语句（例如：CREATE USER user_name WITH PASSWORD '********'；），主要因为当执行达到prepareThreshold指定次数时，数据库将SQL语句进行缓存，基于安全因素不会将密码进行缓存，该prepareStatement再次执行时会报错（Password must contain at least 8 characters.）。

• preparedStatementCacheQueries：Integer类型。确定每个连接中缓存的查询数，默认情况下是256。若在prepareStatement()调用中使用超过256个不同的查询，则最近最少使用的查询缓存将被丢弃。“0”表示禁用缓存。
• preparedStatementCacheSizeMiB：Integer类型。该参数确定了每个连接的cache缓存Statement对象所生成query的最大值（以兆字节为单位），默认情况下是5。若缓存了超过5MB的查询，则最近最少使用的查询缓存将被丢弃。“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类型。批量导入时，该参数设置为true，可将N条插入语句合并为一条：insert into TABLE_NAME values(values1, ..., valuesN), ..., (values1, ..., valuesN);使用该参数时，需设置batchMode=off，缺省值为false。
• unknownLength：Integer类型。默认为Integer.MAX_VALUE。某些postgresql类型（例如TEXT）没有明确定义的长度，当通过ResultSetMetaData.getColumnDisplaySize和ResultSetMetaData.getPrecision等函数返回关于这些类型的数据时，此参数指定未知长度类型的长度。
• uppercaseAttributeName：Boolean类型。默认值为false表示以内核GUC参数配置为准，为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

• binaryTransferDisEnable：String类型。禁用二进制传输的类型列表，以逗号分隔。OID编号和名称二选一。覆盖binaryTransferEnable的设置。
• blobMode：String类型。用于设置setBinaryStream方法为不同类型的数据赋值，设置为on时表示为blob类型数据赋值，设置为off时表示为bytea类型数据赋值，默认为on。建议从A数据库、B数据库迁移来的系统将该值设定为on，从PG数据库迁移来的系统设定为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:postgresql://host1:port1,host2:port2,host3:port3,host4:port4,/database?priorityServers=2。即表示host1与host2为主数据库实例节点，host3与host4为容灾数据库实例节点。

• forceTargetServerSlave：Boolean类型。此值用于控制是否开启强制连接备机功能，并在数据库实例发生主备切换时，禁止已存在的连接在升主备机上继续使用。默认值为false，表示不开启强制连接备机功能。true，表示开启强制连接备机功能。
• traceInterfaceClass：String类型。默认值为NULL，用于获取traceId的实现类。值是实现获取traceId方法接口org.postgresql.log.Tracer的实现类的完整限定类名。
• use_boolean：Boolean类型。用于设置extended模式下setBoolean方法绑定的oid类型，默认为false，绑定int2类型。设置为true则绑定Boolean类型。
• allowReadOnly：Boolean类型。用于设置是否允许只读模式，默认为true，允许设置只读模式；设置为false则禁用只读模式。
• 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，用于指定是否启用服务端时区设置，ture表示获取JVM时区指定数据库时区，false表示使用数据库时区。
• loadBalanceHosts：Boolean类型。在默认模式下（禁用），默认顺序连接URL中指定的多个主机。如果启用，则使用洗牌算法从候选主机中随机选择一个主机建立连接。集中式环境下，如果使用此参数需要保证业务中没有写操作。
• oracleCompatible：String类型。默认为false。用户控制驱动接口的A兼容特性。有以下几种取值：
  1. 设置为true或on，表示开启驱动侧所有的A兼容特性。
  2. 设置为false或off，表示关闭驱动侧所有的A兼容特性。
  3. 设置为“tag1,tag2,tag3”，配置一个或多个tag，tag之间用“,”隔开，表示开启驱动侧部分的A兼容特性，每个tag对应一个A兼容特性。

     当前支持的tag有：

     • getProcedureColumns：DatabaseMetaData#getProcedureColumns接口的行为兼容A行为。
     • batchInsertAffectedRows：reWriteBatchedInserts开启后，执行批量插入接口Statement#executeBatch的返回结果兼容A行为。
• printSqlInLog：Boolean类型。默认值为true，用于指定异常信息中或日志中是否输出sql语句，true表示启用，false表示禁用。
• setFloat：Boolean类型，表示调用setFloat或者setObject指定类型为float时，传递给内核的Oid是否为float4的Oid。true表示开启，传递给内核的Oid为float8，false表示关闭，传递给内核的Oid为float4，默认为false。

user

数据库用户。

password

数据库用户的密码。

502xx

505.2

50200-50299

版本内必须先使用最小可用值

>=502xx最新设置值

相关兼容性改动必须同步合入更高版本分支

501xx

505.1

50100-50199

版本内必须先使用最小可用值

>=501xx最新设置值

相关兼容性改动必须同步合入更高版本分支

500xx

505.0

50000-50099

版本内必须先使用最小可用值

>=500xx最新设置值

相关兼容性改动必须同步合入更高版本分支

301xx

503.1

30100-30199

版本内必须先使用最小可用值

>=301xx最新设置值

相关兼容性改动必须同步合入更高版本分支

300xx

503.0

30000-30099

版本内必须先使用最小可用值

>=300xx最新设置值

相关兼容性改动必须同步合入更高版本分支