API tools faq
paste
Guest User

Untitled

a guest
Nov 13th, 2017
35
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 67.48 KB | None | 0 0
raw download clone embed print report
  1. <ConnectionProperties>
  2. <PropertyCategory name="Connection/Authentication">
  3. <Property name="user" required="No" default="" sortOrder="-2147483647" since="all versions">
  4. The user to connect as
  5. </Property>
  6. <Property name="password" required="No" default="" sortOrder="-2147483646" since="all versions">
  7. The password to use when connecting
  8. </Property>
  9. <Property name="socketFactory" required="No" default="com.mysql.jdbc.StandardSocketFactory" sortOrder="4" since="3.0.3">
  10. The name of the class that the driver should use for creating socket connections to the server. This class must implement the interface 'com.mysql.jdbc.SocketFactory' and have public no-args constructor.
  11. </Property>
  12. <Property name="connectTimeout" required="No" default="0" sortOrder="9" since="3.0.1">
  13. Timeout for socket connect (in milliseconds), with 0 being no timeout. Only works on JDK-1.4 or newer. Defaults to '0'.
  14. </Property>
  15. <Property name="socketTimeout" required="No" default="0" sortOrder="10" since="3.0.1">
  16. Timeout (in milliseconds) on network socket operations (0, the default means no timeout).
  17. </Property>
  18. <Property name="connectionLifecycleInterceptors" required="No" default="" sortOrder="2147483647" since="5.1.4">
  19. A comma-delimited list of classes that implement "com.mysql.jdbc.ConnectionLifecycleInterceptor" that should notified of connection lifecycle events (creation, destruction, commit, rollback, setCatalog and setAutoCommit) and potentially alter the execution of these commands. ConnectionLifecycleInterceptors are "stackable", more than one interceptor may be specified via the configuration property as a comma-delimited list, with the interceptors executed in order from left to right.
  20. </Property>
  21. <Property name="useConfigs" required="No" default="" sortOrder="2147483647" since="3.1.5">
  22. Load the comma-delimited list of configuration properties before parsing the URL or applying user-specified properties. These configurations are explained in the 'Configurations' of the documentation.
  23. </Property>
  24. <Property name="authenticationPlugins" required="No" default="" sortOrder="alpha" since="5.1.19">
  25. Comma-delimited list of classes that implement com.mysql.jdbc.AuthenticationPlugin and which will be used for authentication unless disabled by "disabledAuthenticationPlugins" property.
  26. </Property>
  27. <Property name="defaultAuthenticationPlugin" required="No" default="com.mysql.jdbc.authentication.MysqlNativePasswordPlugin" sortOrder="alpha" since="5.1.19">
  28. Name of a class implementing com.mysql.jdbc.AuthenticationPlugin which will be used as the default authentication plugin (see below). It is an error to use a class which is not listed in "authenticationPlugins" nor it is one of the built-in plugins. It is an error to set as default a plugin which was disabled with "disabledAuthenticationPlugins" property. It is an error to set this value to null or the empty string (i.e. there must be at least a valid default authentication plugin specified for the connection, meeting all constraints listed above).
  29. </Property>
  30. <Property name="disabledAuthenticationPlugins" required="No" default="" sortOrder="alpha" since="5.1.19">
  31. Comma-delimited list of classes implementing com.mysql.jdbc.AuthenticationPlugin or mechanisms, i.e. "mysql_native_password". The authentication plugins or mechanisms listed will not be used for authentication which will fail if it requires one of them. It is an error to disable the default authentication plugin (either the one named by "defaultAuthenticationPlugin" property or the hard-coded one if "defaultAuthenticationPlugin" property is not set).
  32. </Property>
  33. <Property name="disconnectOnExpiredPasswords" required="No" default="true" sortOrder="alpha" since="5.1.23">
  34. If "disconnectOnExpiredPasswords" is set to "false" and password is expired then server enters "sandbox" mode and sends ERR(08001, ER_MUST_CHANGE_PASSWORD) for all commands that are not needed to set a new password until a new password is set.
  35. </Property>
  36. <Property name="interactiveClient" required="No" default="false" sortOrder="alpha" since="3.1.0">
  37. Set the CLIENT_INTERACTIVE flag, which tells MySQL to timeout connections based on INTERACTIVE_TIMEOUT instead of WAIT_TIMEOUT
  38. </Property>
  39. <Property name="localSocketAddress" required="No" default="" sortOrder="alpha" since="5.0.5">
  40. Hostname or IP address given to explicitly configure the interface that the driver will bind the client side of the TCP/IP connection to when connecting.
  41. </Property>
  42. <Property name="propertiesTransform" required="No" default="" sortOrder="alpha" since="3.1.4">
  43. An implementation of com.mysql.jdbc.ConnectionPropertiesTransform that the driver will use to modify URL properties passed to the driver before attempting a connection
  44. </Property>
  45. <Property name="useCompression" required="No" default="false" sortOrder="alpha" since="3.0.17">
  46. Use zlib compression when communicating with the server (true/false)? Defaults to 'false'.
  47. </Property>
  48. </PropertyCategory>
  49. <PropertyCategory name="Networking">
  50. <Property name="socksProxyHost" required="No" default="" sortOrder="1" since="5.1.34">
  51. Name or IP address of SOCKS host to connect through.
  52. </Property>
  53. <Property name="socksProxyPort" required="No" default="1080" sortOrder="2" since="5.1.34">
  54. Port of SOCKS server.
  55. </Property>
  56. <Property name="maxAllowedPacket" required="No" default="-1" sortOrder="alpha" since="5.1.8">
  57. Maximum allowed packet size to send to server. If not set, the value of system variable 'max_allowed_packet' will be used to initialize this upon connecting. This value will not take effect if set larger than the value of 'max_allowed_packet'. Also, due to an internal dependency with the property "blobSendChunkSize", this setting has a minimum value of "8203" if "useServerPrepStmts" is set to "true".
  58. </Property>
  59. <Property name="tcpKeepAlive" required="No" default="true" sortOrder="alpha" since="5.0.7">
  60. If connecting using TCP/IP, should the driver set SO_KEEPALIVE?
  61. </Property>
  62. <Property name="tcpNoDelay" required="No" default="true" sortOrder="alpha" since="5.0.7">
  63. If connecting using TCP/IP, should the driver set SO_TCP_NODELAY (disabling the Nagle Algorithm)?
  64. </Property>
  65. <Property name="tcpRcvBuf" required="No" default="0" sortOrder="alpha" since="5.0.7">
  66. If connecting using TCP/IP, should the driver set SO_RCV_BUF to the given value? The default value of '0', means use the platform default value for this property)
  67. </Property>
  68. <Property name="tcpSndBuf" required="No" default="0" sortOrder="alpha" since="5.0.7">
  69. If connecting using TCP/IP, should the driver set SO_SND_BUF to the given value? The default value of '0', means use the platform default value for this property)
  70. </Property>
  71. <Property name="tcpTrafficClass" required="No" default="0" sortOrder="alpha" since="5.0.7">
  72. If connecting using TCP/IP, should the driver set traffic class or type-of-service fields ?See the documentation for java.net.Socket.setTrafficClass() for more information.
  73. </Property>
  74. </PropertyCategory>
  75. <PropertyCategory name="High Availability and Clustering">
  76. <Property name="autoReconnect" required="No" default="false" sortOrder="0" since="1.1">
  77. Should the driver try to re-establish stale and/or dead connections? If enabled the driver will throw an exception for a queries issued on a stale or dead connection, which belong to the current transaction, but will attempt reconnect before the next query issued on the connection in a new transaction. The use of this feature is not recommended, because it has side effects related to session state and data consistency when applications don't handle SQLExceptions properly, and is only designed to be used when you are unable to configure your application to handle SQLExceptions resulting from dead and stale connections properly. Alternatively, as a last option, investigate setting the MySQL server variable "wait_timeout" to a high value, rather than the default of 8 hours.
  78. </Property>
  79. <Property name="autoReconnectForPools" required="No" default="false" sortOrder="1" since="3.1.3">
  80. Use a reconnection strategy appropriate for connection pools (defaults to 'false')
  81. </Property>
  82. <Property name="failOverReadOnly" required="No" default="true" sortOrder="2" since="3.0.12">
  83. When failing over in autoReconnect mode, should the connection be set to 'read-only'?
  84. </Property>
  85. <Property name="maxReconnects" required="No" default="3" sortOrder="4" since="1.1">
  86. Maximum number of reconnects to attempt if autoReconnect is true, default is '3'.
  87. </Property>
  88. <Property name="reconnectAtTxEnd" required="No" default="false" sortOrder="4" since="3.0.10">
  89. If autoReconnect is set to true, should the driver attempt reconnections at the end of every transaction?
  90. </Property>
  91. <Property name="retriesAllDown" required="No" default="120" sortOrder="4" since="5.1.6">
  92. When using loadbalancing or failover, the number of times the driver should cycle through available hosts, attempting to connect. Between cycles, the driver will pause for 250ms if no servers are available.
  93. </Property>
  94. <Property name="initialTimeout" required="No" default="2" sortOrder="5" since="1.1">
  95. If autoReconnect is enabled, the initial time to wait between re-connect attempts (in seconds, defaults to '2').
  96. </Property>
  97. <Property name="roundRobinLoadBalance" required="No" default="false" sortOrder="5" since="3.1.2">
  98. When autoReconnect is enabled, and failoverReadonly is false, should we pick hosts to connect to on a round-robin basis?
  99. </Property>
  100. <Property name="queriesBeforeRetryMaster" required="No" default="50" sortOrder="7" since="3.0.2">
  101. Number of queries to issue before falling back to the primary host when failed over (when using multi-host failover). Whichever condition is met first, 'queriesBeforeRetryMaster' or 'secondsBeforeRetryMaster' will cause an attempt to be made to reconnect to the primary host. Setting both properties to 0 disables the automatic fall back to the primary host at transaction boundaries. Defaults to 50.
  102. </Property>
  103. <Property name="secondsBeforeRetryMaster" required="No" default="30" sortOrder="8" since="3.0.2">
  104. How long should the driver wait, when failed over, before attempting to reconnect to the primary host? Whichever condition is met first, 'queriesBeforeRetryMaster' or 'secondsBeforeRetryMaster' will cause an attempt to be made to reconnect to the master. Setting both properties to 0 disables the automatic fall back to the primary host at transaction boundaries. Time in seconds, defaults to 30
  105. </Property>
  106. <Property name="allowMasterDownConnections" required="No" default="false" sortOrder="2147483647" since="5.1.27">
  107. By default, a replication-aware connection will fail to connect when configured master hosts are all unavailable at initial connection. Setting this property to 'true' allows to establish the initial connection, by failing over to the slave servers, in read-only state. It won't prevent subsequent failures when switching back to the master hosts i.e. by setting the replication connection to read/write state.
  108. </Property>
  109. <Property name="allowSlaveDownConnections" required="No" default="false" sortOrder="2147483647" since="5.1.38">
  110. By default, a replication-aware connection will fail to connect when configured slave hosts are all unavailable at initial connection. Setting this property to 'true' allows to establish the initial connection. It won't prevent failures when switching to slaves i.e. by setting the replication connection to read-only state. The property 'readFromMasterWhenNoSlaves' should be used for this purpose.
  111. </Property>
  112. <Property name="readFromMasterWhenNoSlaves" required="No" default="false" sortOrder="2147483647" since="5.1.38">
  113. Replication-aware connections distribute load by using the master hosts when in read/write state and by using the slave hosts when in read-only state. If, when setting the connection to read-only state, none of the slave hosts are available, an SQLExeception is thrown back. Setting this property to 'true' allows to fail over to the master hosts, while setting the connection state to read-only, when no slave hosts are available at switch instant.
  114. </Property>
  115. <Property name="replicationEnableJMX" required="No" default="false" sortOrder="2147483647" since="5.1.27">
  116. Enables JMX-based management of load-balanced connection groups, including live addition/removal of hosts from load-balancing pool.
  117. </Property>
  118. <Property name="selfDestructOnPingMaxOperations" required="No" default="0" sortOrder="2147483647" since="5.1.6">
  119. If set to a non-zero value, the driver will report close the connection and report failure when Connection.ping() or Connection.isValid(int) is called if the connection's count of commands sent to the server exceeds this value.
  120. </Property>
  121. <Property name="selfDestructOnPingSecondsLifetime" required="No" default="0" sortOrder="2147483647" since="5.1.6">
  122. If set to a non-zero value, the driver will close the connection and report failure when Connection.ping() or Connection.isValid(int) is called if the connection's lifetime exceeds this value (in milliseconds).
  123. </Property>
  124. <Property name="replicationConnectionGroup" required="No" default="" sortOrder="alpha" since="5.1.27">
  125. Logical group of replication connections within a classloader, used to manage different groups independently. If not specified, live management of replication connections is disabled.
  126. </Property>
  127. <Property name="resourceId" required="No" default="" sortOrder="alpha" since="5.0.1">
  128. A globally unique name that identifies the resource that this datasource or connection is connected to, used for XAResource.isSameRM() when the driver can't determine this value based on hostnames used in the URL
  129. </Property>
  130. </PropertyCategory>
  131. <PropertyCategory name="Security">
  132. <Property name="allowMultiQueries" required="No" default="false" sortOrder="1" since="3.1.1">
  133. Allow the use of ';' to delimit multiple queries during one statement (true/false), defaults to 'false', and does not affect the addBatch() and executeBatch() methods, which instead rely on rewriteBatchStatements.
  134. </Property>
  135. <Property name="useSSL" required="No" default="false" sortOrder="2" since="3.0.2">
  136. Use SSL when communicating with the server (true/false), default is 'true' when connecting to MySQL 5.5.45+, 5.6.26+ or 5.7.6+, otherwise default is 'false'
  137. </Property>
  138. <Property name="requireSSL" required="No" default="false" sortOrder="3" since="3.1.0">
  139. Require server support of SSL connection if useSSL=true? (defaults to 'false').
  140. </Property>
  141. <Property name="verifyServerCertificate" required="No" default="true" sortOrder="4" since="5.1.6">
  142. If "useSSL" is set to "true", should the driver verify the server's certificate? When using this feature, the keystore parameters should be specified by the "clientCertificateKeyStore*" properties, rather than system properties. Default is 'false' when connecting to MySQL 5.5.45+, 5.6.26+ or 5.7.6+ and "useSSL" was not explicitly set to "true". Otherwise default is 'true'
  143. </Property>
  144. <Property name="clientCertificateKeyStoreUrl" required="No" default="" sortOrder="5" since="5.1.0">
  145. URL to the client certificate KeyStore (if not specified, use defaults)
  146. </Property>
  147. <Property name="clientCertificateKeyStoreType" required="No" default="JKS" sortOrder="6" since="5.1.0">
  148. KeyStore type for client certificates (NULL or empty means use the default, which is "JKS". Standard keystore types supported by the JVM are "JKS" and "PKCS12", your environment may have more available depending on what security products are installed and available to the JVM.
  149. </Property>
  150. <Property name="clientCertificateKeyStorePassword" required="No" default="" sortOrder="7" since="5.1.0">
  151. Password for the client certificates KeyStore
  152. </Property>
  153. <Property name="trustCertificateKeyStoreUrl" required="No" default="" sortOrder="8" since="5.1.0">
  154. URL to the trusted root certificate KeyStore (if not specified, use defaults)
  155. </Property>
  156. <Property name="trustCertificateKeyStoreType" required="No" default="JKS" sortOrder="9" since="5.1.0">
  157. KeyStore type for trusted root certificates (NULL or empty means use the default, which is "JKS". Standard keystore types supported by the JVM are "JKS" and "PKCS12", your environment may have more available depending on what security products are installed and available to the JVM.
  158. </Property>
  159. <Property name="trustCertificateKeyStorePassword" required="No" default="" sortOrder="10" since="5.1.0">
  160. Password for the trusted root certificates KeyStore
  161. </Property>
  162. <Property name="enabledSSLCipherSuites" required="No" default="" sortOrder="11" since="5.1.35">
  163. If "useSSL" is set to "true", overrides the cipher suites enabled for use on the underlying SSL sockets. This may be required when using external JSSE providers or to specify cipher suites compatible with both MySQL server and used JVM.
  164. </Property>
  165. <Property name="enabledTLSProtocols" required="No" default="" sortOrder="12" since="5.1.44">
  166. If "useSSL" is set to "true", overrides the TLS protocols enabled for use on the underlying SSL sockets. This may be used to restrict connections to specific TLS versions.
  167. </Property>
  168. <Property name="allowLoadLocalInfile" required="No" default="true" sortOrder="2147483647" since="3.0.3">
  169. Should the driver allow use of 'LOAD DATA LOCAL INFILE...' (defaults to 'true').
  170. </Property>
  171. <Property name="allowUrlInLocalInfile" required="No" default="false" sortOrder="2147483647" since="3.1.4">
  172. Should the driver allow URLs in 'LOAD DATA LOCAL INFILE' statements?
  173. </Property>
  174. <Property name="allowPublicKeyRetrieval" required="No" default="false" sortOrder="alpha" since="5.1.31">
  175. Allows special handshake roundtrip to get server RSA public key directly from server.
  176. </Property>
  177. <Property name="paranoid" required="No" default="false" sortOrder="alpha" since="3.0.1">
  178. Take measures to prevent exposure sensitive information in error messages and clear data structures holding sensitive data when possible? (defaults to 'false')
  179. </Property>
  180. <Property name="passwordCharacterEncoding" required="No" default="" sortOrder="alpha" since="5.1.7">
  181. What character encoding is used for passwords? Leaving this set to the default value (null), uses the value set in "characterEncoding" if there is one, otherwise uses UTF-8 as default encoding. If the password contains non-ASCII characters, the password encoding must match what server encoding was set to when the password was created. For passwords in other character encodings, the encoding will have to be specified with this property (or with "characterEncoding"), as it's not possible for the driver to auto-detect this.
  182. </Property>
  183. <Property name="serverRSAPublicKeyFile" required="No" default="" sortOrder="alpha" since="5.1.31">
  184. File path to the server RSA public key file for sha256_password authentication. If not specified, the public key will be retrieved from the server.
  185. </Property>
  186. </PropertyCategory>
  187. <PropertyCategory name="Performance Extensions">
  188. <Property name="callableStmtCacheSize" required="No" default="100" sortOrder="5" since="3.1.2">
  189. If 'cacheCallableStmts' is enabled, how many callable statements should be cached?
  190. </Property>
  191. <Property name="metadataCacheSize" required="No" default="50" sortOrder="5" since="3.1.1">
  192. The number of queries to cache ResultSetMetadata for if cacheResultSetMetaData is set to 'true' (default 50)
  193. </Property>
  194. <Property name="useLocalSessionState" required="No" default="false" sortOrder="5" since="3.1.7">
  195. Should the driver refer to the internal values of autocommit and transaction isolation that are set by Connection.setAutoCommit() and Connection.setTransactionIsolation() and transaction state as maintained by the protocol, rather than querying the database or blindly sending commands to the database for commit() or rollback() method calls?
  196. </Property>
  197. <Property name="useLocalTransactionState" required="No" default="false" sortOrder="6" since="5.1.7">
  198. Should the driver use the in-transaction state provided by the MySQL protocol to determine if a commit() or rollback() should actually be sent to the database?
  199. </Property>
  200. <Property name="prepStmtCacheSize" required="No" default="25" sortOrder="10" since="3.0.10">
  201. If prepared statement caching is enabled, how many prepared statements should be cached?
  202. </Property>
  203. <Property name="prepStmtCacheSqlLimit" required="No" default="256" sortOrder="11" since="3.0.10">
  204. If prepared statement caching is enabled, what's the largest SQL the driver will cache the parsing for?
  205. </Property>
  206. <Property name="parseInfoCacheFactory" required="No" default="com.mysql.jdbc.PerConnectionLRUFactory" sortOrder="12" since="5.1.1">
  207. Name of a class implementing com.mysql.jdbc.CacheAdapterFactory, which will be used to create caches for the parsed representation of client-side prepared statements.
  208. </Property>
  209. <Property name="serverConfigCacheFactory" required="No" default="com.mysql.jdbc.PerVmServerConfigCacheFactory" sortOrder="12" since="5.1.1">
  210. Name of a class implementing com.mysql.jdbc.CacheAdapterFactory&lt;String, Map&lt;String, String&gt;&gt;, which will be used to create caches for MySQL server configuration values
  211. </Property>
  212. <Property name="alwaysSendSetIsolation" required="No" default="true" sortOrder="2147483647" since="3.1.7">
  213. Should the driver always communicate with the database when Connection.setTransactionIsolation() is called? If set to false, the driver will only communicate with the database when the requested transaction isolation is different than the whichever is newer, the last value that was set via Connection.setTransactionIsolation(), or the value that was read from the server when the connection was established. Note that useLocalSessionState=true will force the same behavior as alwaysSendSetIsolation=false, regardless of how alwaysSendSetIsolation is set.
  214. </Property>
  215. <Property name="maintainTimeStats" required="No" default="true" sortOrder="2147483647" since="3.1.9">
  216. Should the driver maintain various internal timers to enable idle time calculations as well as more verbose error messages when the connection to the server fails? Setting this property to false removes at least two calls to System.getCurrentTimeMillis() per query.
  217. </Property>
  218. <Property name="useCursorFetch" required="No" default="false" sortOrder="2147483647" since="5.0.0">
  219. If connected to MySQL &gt; 5.0.2, and setFetchSize() &gt; 0 on a statement, should that statement use cursor-based fetching to retrieve rows?
  220. </Property>
  221. <Property name="blobSendChunkSize" required="No" default="1048576" sortOrder="alpha" since="3.1.9">
  222. Chunk size to use when sending BLOB/CLOBs via ServerPreparedStatements. Note that this value cannot exceed the value of "maxAllowedPacket" and, if that is the case, then this value will be corrected automatically.
  223. </Property>
  224. <Property name="cacheCallableStmts" required="No" default="false" sortOrder="alpha" since="3.1.2">
  225. Should the driver cache the parsing stage of CallableStatements
  226. </Property>
  227. <Property name="cachePrepStmts" required="No" default="false" sortOrder="alpha" since="3.0.10">
  228. Should the driver cache the parsing stage of PreparedStatements of client-side prepared statements, the "check" for suitability of server-side prepared and server-side prepared statements themselves?
  229. </Property>
  230. <Property name="cacheResultSetMetadata" required="No" default="false" sortOrder="alpha" since="3.1.1">
  231. Should the driver cache ResultSetMetaData for Statements and PreparedStatements? (Req. JDK-1.4+, true/false, default 'false')
  232. </Property>
  233. <Property name="cacheServerConfiguration" required="No" default="false" sortOrder="alpha" since="3.1.5">
  234. Should the driver cache the results of 'SHOW VARIABLES' and 'SHOW COLLATION' on a per-URL basis?
  235. </Property>
  236. <Property name="defaultFetchSize" required="No" default="0" sortOrder="alpha" since="3.1.9">
  237. The driver will call setFetchSize(n) with this value on all newly-created Statements
  238. </Property>
  239. <Property name="dontCheckOnDuplicateKeyUpdateInSQL" required="No" default="false" sortOrder="alpha" since="5.1.32">
  240. Stops checking if every INSERT statement contains the "ON DUPLICATE KEY UPDATE" clause. As a side effect, obtaining the statement's generated keys information will return a list where normally it wouldn't. Also be aware that, in this case, the list of generated keys returned may not be accurate. The effect of this property is canceled if set simultaneously with 'rewriteBatchedStatements=true'.
  241. </Property>
  242. <Property name="dontTrackOpenResources" required="No" default="false" sortOrder="alpha" since="3.1.7">
  243. The JDBC specification requires the driver to automatically track and close resources, however if your application doesn't do a good job of explicitly calling close() on statements or result sets, this can cause memory leakage. Setting this property to true relaxes this constraint, and can be more memory efficient for some applications. Also the automatic closing of the Statement and current ResultSet in Statement.closeOnCompletion() and Statement.getMoreResults ([Statement.CLOSE_CURRENT_RESULT | Statement.CLOSE_ALL_RESULTS]), respectively, ceases to happen. This property automatically sets holdResultsOpenOverStatementClose=true.
  244. </Property>
  245. <Property name="dynamicCalendars" required="No" default="false" sortOrder="alpha" since="3.1.5">
  246. Should the driver retrieve the default calendar when required, or cache it per connection/session?
  247. </Property>
  248. <Property name="elideSetAutoCommits" required="No" default="false" sortOrder="alpha" since="3.1.3">
  249. If using MySQL-4.1 or newer, should the driver only issue 'set autocommit=n' queries when the server's state doesn't match the requested state by Connection.setAutoCommit(boolean)?
  250. </Property>
  251. <Property name="enableEscapeProcessing" required="No" default="true" sortOrder="alpha" since="5.1.37">
  252. Sets the default escape processing behavior for Statement objects. The method Statement.setEscapeProcessing() can be used to specify the escape processing behavior for an individual Statement object. Default escape processing behavior in prepared statements must be defined with the property 'processEscapeCodesForPrepStmts'.
  253. </Property>
  254. <Property name="enableQueryTimeouts" required="No" default="true" sortOrder="alpha" since="5.0.6">
  255. When enabled, query timeouts set via Statement.setQueryTimeout() use a shared java.util.Timer instance for scheduling. Even if the timeout doesn't expire before the query is processed, there will be memory used by the TimerTask for the given timeout which won't be reclaimed until the time the timeout would have expired if it hadn't been cancelled by the driver. High-load environments might want to consider disabling this functionality.
  256. </Property>
  257. <Property name="holdResultsOpenOverStatementClose" required="No" default="false" sortOrder="alpha" since="3.1.7">
  258. Should the driver close result sets on Statement.close() as required by the JDBC specification?
  259. </Property>
  260. <Property name="largeRowSizeThreshold" required="No" default="2048" sortOrder="alpha" since="5.1.1">
  261. What size result set row should the JDBC driver consider "large", and thus use a more memory-efficient way of representing the row internally?
  262. </Property>
  263. <Property name="loadBalanceStrategy" required="No" default="random" sortOrder="alpha" since="5.0.6">
  264. If using a load-balanced connection to connect to SQL nodes in a MySQL Cluster/NDB configuration (by using the URL prefix "jdbc:mysql:loadbalance://"), which load balancing algorithm should the driver use: (1) "random" - the driver will pick a random host for each request. This tends to work better than round-robin, as the randomness will somewhat account for spreading loads where requests vary in response time, while round-robin can sometimes lead to overloaded nodes if there are variations in response times across the workload. (2) "bestResponseTime" - the driver will route the request to the host that had the best response time for the previous transaction. (3) "serverAffinity" - the driver initially attempts to enforce server affinity while still respecting and benefiting from the fault tolerance aspects of the load-balancing implementation. The server affinity ordered list is provided using the property 'serverAffinityOrder'. If none of the servers listed in the affinity list is responsive, the driver then refers to the "random" strategy to proceed with choosing the next server.
  265. </Property>
  266. <Property name="locatorFetchBufferSize" required="No" default="1048576" sortOrder="alpha" since="3.2.1">
  267. If 'emulateLocators' is configured to 'true', what size buffer should be used when fetching BLOB data for getBinaryInputStream?
  268. </Property>
  269. <Property name="readOnlyPropagatesToServer" required="No" default="true" sortOrder="alpha" since="5.1.35">
  270. Should the driver issue appropriate statements to implicitly set the transaction access mode on server side when Connection.setReadOnly() is called? Setting this property to 'true' enables InnoDB read-only potential optimizations but also requires an extra roundtrip to set the right transaction state. Even if this property is set to 'false', the driver will do its best effort to prevent the execution of database-state-changing queries. Requires minimum of MySQL 5.6.
  271. </Property>
  272. <Property name="rewriteBatchedStatements" required="No" default="false" sortOrder="alpha" since="3.1.13">
  273. Should the driver use multiqueries (irregardless of the setting of "allowMultiQueries") as well as rewriting of prepared statements for INSERT into multi-value inserts when executeBatch() is called? Notice that this has the potential for SQL injection if using plain java.sql.Statements and your code doesn't sanitize input correctly. Notice that for prepared statements, server-side prepared statements can not currently take advantage of this rewrite option, and that if you don't specify stream lengths when using PreparedStatement.set*Stream(), the driver won't be able to determine the optimum number of parameters per batch and you might receive an error from the driver that the resultant packet is too large. Statement.getGeneratedKeys() for these rewritten statements only works when the entire batch includes INSERT statements. Please be aware using rewriteBatchedStatements=true with INSERT .. ON DUPLICATE KEY UPDATE that for rewritten statement server returns only one value as sum of all affected (or found) rows in batch and it isn't possible to map it correctly to initial statements; in this case driver returns 0 as a result of each batch statement if total count was 0, and the Statement.SUCCESS_NO_INFO as a result of each batch statement if total count was > 0.
  274. </Property>
  275. <Property name="serverAffinityOrder" required="No" default="" sortOrder="alpha" since="5.1.43">
  276. A comma separated list containing the host/port pairs that are to be used in load-balancing "serverAffinity" strategy. Only the sub-set of the hosts enumerated in the main hosts section in this URL will be used and they must be identical in case and type, i.e., can't use an IP address in one place and the corresponding host name in the other.
  277. </Property>
  278. <Property name="useDirectRowUnpack" required="No" default="true" sortOrder="alpha" since="5.1.1">
  279. Use newer result set row unpacking code that skips a copy from network buffers to a MySQL packet instance and instead reads directly into the result set row data buffers.
  280. </Property>
  281. <Property name="useDynamicCharsetInfo" required="No" default="true" sortOrder="alpha" since="5.0.6">
  282. Should the driver use a per-connection cache of character set information queried from the server when necessary, or use a built-in static mapping that is more efficient, but isn't aware of custom character sets or character sets implemented after the release of the JDBC driver?
  283. </Property>
  284. <Property name="useFastDateParsing" required="No" default="true" sortOrder="alpha" since="5.0.5">
  285. Use internal String->Date/Time/Timestamp conversion routines to avoid excessive object creation? This is part of the legacy date-time code, thus the property has an effect only when "useLegacyDatetimeCode=true."
  286. </Property>
  287. <Property name="useFastIntParsing" required="No" default="true" sortOrder="alpha" since="3.1.4">
  288. Use internal String->Integer conversion routines to avoid excessive object creation?
  289. </Property>
  290. <Property name="useJvmCharsetConverters" required="No" default="false" sortOrder="alpha" since="5.0.1">
  291. Always use the character encoding routines built into the JVM, rather than using lookup tables for single-byte character sets?
  292. </Property>
  293. <Property name="useReadAheadInput" required="No" default="true" sortOrder="alpha" since="3.1.5">
  294. Use newer, optimized non-blocking, buffered input stream when reading from the server?
  295. </Property>
  296. </PropertyCategory>
  297. <PropertyCategory name="Debugging/Profiling">
  298. <Property name="logger" required="No" default="com.mysql.jdbc.log.StandardLogger" sortOrder="0" since="3.1.1">
  299. The name of a class that implements "com.mysql.jdbc.log.Log" that will be used to log messages to. (default is "com.mysql.jdbc.log.StandardLogger", which logs to STDERR)
  300. </Property>
  301. <Property name="gatherPerfMetrics" required="No" default="false" sortOrder="1" since="3.1.2">
  302. Should the driver gather performance metrics, and report them via the configured logger every 'reportMetricsIntervalMillis' milliseconds?
  303. </Property>
  304. <Property name="profileSQL" required="No" default="false" sortOrder="1" since="3.1.0">
  305. Trace queries and their execution/fetch times to the configured logger (true/false) defaults to 'false'
  306. </Property>
  307. <Property name="profileSql" required="No" default="" sortOrder="3" since="2.0.14">
  308. Deprecated, use 'profileSQL' instead. Trace queries and their execution/fetch times on STDERR (true/false) defaults to 'false'
  309. </Property>
  310. <Property name="reportMetricsIntervalMillis" required="No" default="30000" sortOrder="3" since="3.1.2">
  311. If 'gatherPerfMetrics' is enabled, how often should they be logged (in ms)?
  312. </Property>
  313. <Property name="maxQuerySizeToLog" required="No" default="2048" sortOrder="4" since="3.1.3">
  314. Controls the maximum length/size of a query that will get logged when profiling or tracing
  315. </Property>
  316. <Property name="packetDebugBufferSize" required="No" default="20" sortOrder="7" since="3.1.3">
  317. The maximum number of packets to retain when 'enablePacketDebug' is true
  318. </Property>
  319. <Property name="slowQueryThresholdMillis" required="No" default="2000" sortOrder="9" since="3.1.2">
  320. If 'logSlowQueries' is enabled, how long should a query (in ms) before it is logged as 'slow'?
  321. </Property>
  322. <Property name="slowQueryThresholdNanos" required="No" default="0" sortOrder="10" since="5.0.7">
  323. If 'useNanosForElapsedTime' is set to true, and this property is set to a non-zero value, the driver will use this threshold (in nanosecond units) to determine if a query was slow.
  324. </Property>
  325. <Property name="useUsageAdvisor" required="No" default="false" sortOrder="10" since="3.1.1">
  326. Should the driver issue 'usage' warnings advising proper and efficient usage of JDBC and MySQL Connector/J to the log (true/false, defaults to 'false')?
  327. </Property>
  328. <Property name="autoGenerateTestcaseScript" required="No" default="false" sortOrder="alpha" since="3.1.9">
  329. Should the driver dump the SQL it is executing, including server-side prepared statements to STDERR?
  330. </Property>
  331. <Property name="autoSlowLog" required="No" default="true" sortOrder="alpha" since="5.1.4">
  332. Instead of using slowQueryThreshold* to determine if a query is slow enough to be logged, maintain statistics that allow the driver to determine queries that are outside the 99th percentile?
  333. </Property>
  334. <Property name="clientInfoProvider" required="No" default="com.mysql.jdbc.JDBC4CommentClientInfoProvider" sortOrder="alpha" since="5.1.0">
  335. The name of a class that implements the com.mysql.jdbc.JDBC4ClientInfoProvider interface in order to support JDBC-4.0's Connection.get/setClientInfo() methods
  336. </Property>
  337. <Property name="dumpMetadataOnColumnNotFound" required="No" default="false" sortOrder="alpha" since="3.1.13">
  338. Should the driver dump the field-level metadata of a result set into the exception message when ResultSet.findColumn() fails?
  339. </Property>
  340. <Property name="dumpQueriesOnException" required="No" default="false" sortOrder="alpha" since="3.1.3">
  341. Should the driver dump the contents of the query sent to the server in the message for SQLExceptions?
  342. </Property>
  343. <Property name="enablePacketDebug" required="No" default="false" sortOrder="alpha" since="3.1.3">
  344. When enabled, a ring-buffer of 'packetDebugBufferSize' packets will be kept, and dumped when exceptions are thrown in key areas in the driver's code
  345. </Property>
  346. <Property name="explainSlowQueries" required="No" default="false" sortOrder="alpha" since="3.1.2">
  347. If 'logSlowQueries' is enabled, should the driver automatically issue an 'EXPLAIN' on the server and send the results to the configured log at a WARN level?
  348. </Property>
  349. <Property name="includeInnodbStatusInDeadlockExceptions" required="No" default="false" sortOrder="alpha" since="5.0.7">
  350. Include the output of "SHOW ENGINE INNODB STATUS" in exception messages when deadlock exceptions are detected?
  351. </Property>
  352. <Property name="includeThreadDumpInDeadlockExceptions" required="No" default="false" sortOrder="alpha" since="5.1.15">
  353. Include a current Java thread dump in exception messages when deadlock exceptions are detected?
  354. </Property>
  355. <Property name="includeThreadNamesAsStatementComment" required="No" default="false" sortOrder="alpha" since="5.1.15">
  356. Include the name of the current thread as a comment visible in "SHOW PROCESSLIST", or in Innodb deadlock dumps, useful in correlation with "includeInnodbStatusInDeadlockExceptions=true" and "includeThreadDumpInDeadlockExceptions=true".
  357. </Property>
  358. <Property name="logSlowQueries" required="No" default="false" sortOrder="alpha" since="3.1.2">
  359. Should queries that take longer than 'slowQueryThresholdMillis' be logged?
  360. </Property>
  361. <Property name="logXaCommands" required="No" default="false" sortOrder="alpha" since="5.0.5">
  362. Should the driver log XA commands sent by MysqlXaConnection to the server, at the DEBUG level of logging?
  363. </Property>
  364. <Property name="profilerEventHandler" required="No" default="com.mysql.jdbc.profiler.LoggingProfilerEventHandler" sortOrder="alpha" since="5.1.6">
  365. Name of a class that implements the interface com.mysql.jdbc.profiler.ProfilerEventHandler that will be used to handle profiling/tracing events.
  366. </Property>
  367. <Property name="resultSetSizeThreshold" required="No" default="100" sortOrder="alpha" since="5.0.5">
  368. If the usage advisor is enabled, how many rows should a result set contain before the driver warns that it is suspiciously large?
  369. </Property>
  370. <Property name="traceProtocol" required="No" default="false" sortOrder="alpha" since="3.1.2">
  371. Should trace-level network protocol be logged?
  372. </Property>
  373. <Property name="useNanosForElapsedTime" required="No" default="false" sortOrder="alpha" since="5.0.7">
  374. For profiling/debugging functionality that measures elapsed time, should the driver try to use nanoseconds resolution if available (JDK >= 1.5)?
  375. </Property>
  376. </PropertyCategory>
  377. <PropertyCategory name="Miscellaneous">
  378. <Property name="useUnicode" required="No" default="true" sortOrder="0" since="1.1g">
  379. Should the driver use Unicode character encodings when handling strings? Should only be used when the driver can't determine the character set mapping, or you are trying to 'force' the driver to use a character set that MySQL either doesn't natively support (such as UTF-8), true/false, defaults to 'true'
  380. </Property>
  381. <Property name="characterEncoding" required="No" default="" sortOrder="5" since="1.1g">
  382. If 'useUnicode' is set to true, what character encoding should the driver use when dealing with strings? (defaults is to 'autodetect')
  383. </Property>
  384. <Property name="characterSetResults" required="No" default="" sortOrder="6" since="3.0.13">
  385. Character set to tell the server to return results as.
  386. </Property>
  387. <Property name="connectionAttributes" required="No" default="" sortOrder="7" since="5.1.25">
  388. A comma-delimited list of user-defined key:value pairs (in addition to standard MySQL-defined key:value pairs) to be passed to MySQL Server for display as connection attributes in the PERFORMANCE_SCHEMA.SESSION_CONNECT_ATTRS table. Example usage: connectionAttributes=key1:value1,key2:value2 This functionality is available for use with MySQL Server version 5.6 or later only. Earlier versions of MySQL Server do not support connection attributes, causing this configuration option to be ignored. Setting connectionAttributes=none will cause connection attribute processing to be bypassed, for situations where Connection creation/initialization speed is critical.
  389. </Property>
  390. <Property name="connectionCollation" required="No" default="" sortOrder="7" since="3.0.13">
  391. If set, tells the server to use this collation via 'set collation_connection'
  392. </Property>
  393. <Property name="useBlobToStoreUTF8OutsideBMP" required="No" default="false" sortOrder="128" since="5.1.3">
  394. Tells the driver to treat [MEDIUM/LONG]BLOB columns as [LONG]VARCHAR columns holding text encoded in UTF-8 that has characters outside the BMP (4-byte encodings), which MySQL server can't handle natively.
  395. </Property>
  396. <Property name="utf8OutsideBmpExcludedColumnNamePattern" required="No" default="" sortOrder="129" since="5.1.3">
  397. When "useBlobToStoreUTF8OutsideBMP" is set to "true", column names matching the given regex will still be treated as BLOBs unless they match the regex specified for "utf8OutsideBmpIncludedColumnNamePattern". The regex must follow the patterns used for the java.util.regex package.
  398. </Property>
  399. <Property name="utf8OutsideBmpIncludedColumnNamePattern" required="No" default="" sortOrder="129" since="5.1.3">
  400. Used to specify exclusion rules to "utf8OutsideBmpExcludedColumnNamePattern". The regex must follow the patterns used for the java.util.regex package.
  401. </Property>
  402. <Property name="loadBalanceEnableJMX" required="No" default="false" sortOrder="2147483647" since="5.1.13">
  403. Enables JMX-based management of load-balanced connection groups, including live addition/removal of hosts from load-balancing pool.
  404. </Property>
  405. <Property name="loadBalanceHostRemovalGracePeriod" required="No" default="15000" sortOrder="2147483647" since="5.1.39">
  406. Sets the grace period to wait for a host being removed from a load-balanced connection, to be released when it is currently the active host.
  407. </Property>
  408. <Property name="sessionVariables" required="No" default="" sortOrder="2147483647" since="3.1.8">
  409. A comma or semicolon separated list of name=value pairs to be sent as SET [SESSION] ... to the server when the driver connects.
  410. </Property>
  411. <Property name="useColumnNamesInFindColumn" required="No" default="false" sortOrder="2147483647" since="5.1.7">
  412. Prior to JDBC-4.0, the JDBC specification had a bug related to what could be given as a "column name" to ResultSet methods like findColumn(), or getters that took a String property. JDBC-4.0 clarified "column name" to mean the label, as given in an "AS" clause and returned by ResultSetMetaData.getColumnLabel(), and if no AS clause, the column name. Setting this property to "true" will give behavior that is congruent to JDBC-3.0 and earlier versions of the JDBC specification, but which because of the specification bug could give unexpected results. This property is preferred over "useOldAliasMetadataBehavior" unless you need the specific behavior that it provides with respect to ResultSetMetadata.
  413. </Property>
  414. <Property name="allowNanAndInf" required="No" default="false" sortOrder="alpha" since="3.1.5">
  415. Should the driver allow NaN or +/- INF values in PreparedStatement.setDouble()?
  416. </Property>
  417. <Property name="autoClosePStmtStreams" required="No" default="false" sortOrder="alpha" since="3.1.12">
  418. Should the driver automatically call .close() on streams/readers passed as arguments via set*() methods?
  419. </Property>
  420. <Property name="autoDeserialize" required="No" default="false" sortOrder="alpha" since="3.1.5">
  421. Should the driver automatically detect and de-serialize objects stored in BLOB fields?
  422. </Property>
  423. <Property name="blobsAreStrings" required="No" default="false" sortOrder="alpha" since="5.0.8">
  424. Should the driver always treat BLOBs as Strings - specifically to work around dubious metadata returned by the server for GROUP BY clauses?
  425. </Property>
  426. <Property name="cacheDefaultTimezone" required="No" default="true" sortOrder="alpha" since="5.1.35">
  427. Caches client's default time zone. This results in better performance when dealing with time zone conversions in Date and Time data types, however it won't be aware of time zone changes if they happen at runtime.
  428. </Property>
  429. <Property name="capitalizeTypeNames" required="No" default="true" sortOrder="alpha" since="2.0.7">
  430. Capitalize type names in DatabaseMetaData? (usually only useful when using WebObjects, true/false, defaults to 'false')
  431. </Property>
  432. <Property name="clobCharacterEncoding" required="No" default="" sortOrder="alpha" since="5.0.0">
  433. The character encoding to use for sending and retrieving TEXT, MEDIUMTEXT and LONGTEXT values instead of the configured connection characterEncoding
  434. </Property>
  435. <Property name="clobberStreamingResults" required="No" default="false" sortOrder="alpha" since="3.0.9">
  436. This will cause a 'streaming' ResultSet to be automatically closed, and any outstanding data still streaming from the server to be discarded if another query is executed before all the data has been read from the server.
  437. </Property>
  438. <Property name="compensateOnDuplicateKeyUpdateCounts" required="No" default="false" sortOrder="alpha" since="5.1.7">
  439. Should the driver compensate for the update counts of "ON DUPLICATE KEY" INSERT statements (2 = 1, 0 = 1) when using prepared statements?
  440. </Property>
  441. <Property name="continueBatchOnError" required="No" default="true" sortOrder="alpha" since="3.0.3">
  442. Should the driver continue processing batch commands if one statement fails. The JDBC spec allows either way (defaults to 'true').
  443. </Property>
  444. <Property name="createDatabaseIfNotExist" required="No" default="false" sortOrder="alpha" since="3.1.9">
  445. Creates the database given in the URL if it doesn't yet exist. Assumes the configured user has permissions to create databases.
  446. </Property>
  447. <Property name="detectCustomCollations" required="No" default="false" sortOrder="alpha" since="5.1.29">
  448. Should the driver detect custom charsets/collations installed on server (true/false, defaults to 'false'). If this option set to 'true' driver gets actual charsets/collations from server each time connection establishes. This could slow down connection initialization significantly.
  449. </Property>
  450. <Property name="emptyStringsConvertToZero" required="No" default="true" sortOrder="alpha" since="3.1.8">
  451. Should the driver allow conversions from empty string fields to numeric values of '0'?
  452. </Property>
  453. <Property name="emulateLocators" required="No" default="false" sortOrder="alpha" since="3.1.0">
  454. Should the driver emulate java.sql.Blobs with locators? With this feature enabled, the driver will delay loading the actual Blob data until the one of the retrieval methods (getInputStream(), getBytes(), and so forth) on the blob data stream has been accessed. For this to work, you must use a column alias with the value of the column to the actual name of the Blob. The feature also has the following restrictions: The SELECT that created the result set must reference only one table, the table must have a primary key; the SELECT must alias the original blob column name, specified as a string, to an alternate name; the SELECT must cover all columns that make up the primary key.
  455. </Property>
  456. <Property name="emulateUnsupportedPstmts" required="No" default="true" sortOrder="alpha" since="3.1.7">
  457. Should the driver detect prepared statements that are not supported by the server, and replace them with client-side emulated versions?
  458. </Property>
  459. <Property name="exceptionInterceptors" required="No" default="" sortOrder="alpha" since="5.1.8">
  460. Comma-delimited list of classes that implement com.mysql.jdbc.ExceptionInterceptor. These classes will be instantiated one per Connection instance, and all SQLExceptions thrown by the driver will be allowed to be intercepted by these interceptors, in a chained fashion, with the first class listed as the head of the chain.
  461. </Property>
  462. <Property name="functionsNeverReturnBlobs" required="No" default="false" sortOrder="alpha" since="5.0.8">
  463. Should the driver always treat data from functions returning BLOBs as Strings - specifically to work around dubious metadata returned by the server for GROUP BY clauses?
  464. </Property>
  465. <Property name="generateSimpleParameterMetadata" required="No" default="false" sortOrder="alpha" since="5.0.5">
  466. Should the driver generate simplified parameter metadata for PreparedStatements when no metadata is available either because the server couldn't support preparing the statement, or server-side prepared statements are disabled?
  467. </Property>
  468. <Property name="getProceduresReturnsFunctions" required="No" default="true" sortOrder="alpha" since="5.1.26">
  469. Pre-JDBC4 DatabaseMetaData API has only the getProcedures() and getProcedureColumns() methods, so they return metadata info for both stored procedures and functions. JDBC4 was extended with the getFunctions() and getFunctionColumns() methods and the expected behaviours of previous methods are not well defined. For JDBC4 and higher, default 'true' value of the option means that calls of DatabaseMetaData.getProcedures() and DatabaseMetaData.getProcedureColumns() return metadata for both procedures and functions as before, keeping backward compatibility. Setting this property to 'false' decouples Connector/J from its pre-JDBC4 behaviours for DatabaseMetaData.getProcedures() and DatabaseMetaData.getProcedureColumns(), forcing them to return metadata for procedures only.
  470. </Property>
  471. <Property name="ignoreNonTxTables" required="No" default="false" sortOrder="alpha" since="3.0.9">
  472. Ignore non-transactional table warning for rollback? (defaults to 'false').
  473. </Property>
  474. <Property name="jdbcCompliantTruncation" required="No" default="true" sortOrder="alpha" since="3.1.2">
  475. Should the driver throw java.sql.DataTruncation exceptions when data is truncated as is required by the JDBC specification when connected to a server that supports warnings (MySQL 4.1.0 and newer)? This property has no effect if the server sql-mode includes STRICT_TRANS_TABLES.
  476. </Property>
  477. <Property name="loadBalanceAutoCommitStatementRegex" required="No" default="" sortOrder="alpha" since="5.1.15">
  478. When load-balancing is enabled for auto-commit statements (via loadBalanceAutoCommitStatementThreshold), the statement counter will only increment when the SQL matches the regular expression. By default, every statement issued matches.
  479. </Property>
  480. <Property name="loadBalanceAutoCommitStatementThreshold" required="No" default="0" sortOrder="alpha" since="5.1.15">
  481. When auto-commit is enabled, the number of statements which should be executed before triggering load-balancing to rebalance. Default value of 0 causes load-balanced connections to only rebalance when exceptions are encountered, or auto-commit is disabled and transactions are explicitly committed or rolled back.
  482. </Property>
  483. <Property name="loadBalanceBlacklistTimeout" required="No" default="0" sortOrder="alpha" since="5.1.0">
  484. Time in milliseconds between checks of servers which are unavailable, by controlling how long a server lives in the global blacklist.
  485. </Property>
  486. <Property name="loadBalanceConnectionGroup" required="No" default="" sortOrder="alpha" since="5.1.13">
  487. Logical group of load-balanced connections within a classloader, used to manage different groups independently. If not specified, live management of load-balanced connections is disabled.
  488. </Property>
  489. <Property name="loadBalanceExceptionChecker" required="No" default="com.mysql.jdbc.StandardLoadBalanceExceptionChecker" sortOrder="alpha" since="5.1.13">
  490. Fully-qualified class name of custom exception checker. The class must implement com.mysql.jdbc.LoadBalanceExceptionChecker interface, and is used to inspect SQLExceptions and determine whether they should trigger fail-over to another host in a load-balanced deployment.
  491. </Property>
  492. <Property name="loadBalancePingTimeout" required="No" default="0" sortOrder="alpha" since="5.1.13">
  493. Time in milliseconds to wait for ping response from each of load-balanced physical connections when using load-balanced Connection.
  494. </Property>
  495. <Property name="loadBalanceSQLExceptionSubclassFailover" required="No" default="" sortOrder="alpha" since="5.1.13">
  496. Comma-delimited list of classes/interfaces used by default load-balanced exception checker to determine whether a given SQLException should trigger failover. The comparison is done using Class.isInstance(SQLException) using the thrown SQLException.
  497. </Property>
  498. <Property name="loadBalanceSQLStateFailover" required="No" default="" sortOrder="alpha" since="5.1.13">
  499. Comma-delimited list of SQLState codes used by default load-balanced exception checker to determine whether a given SQLException should trigger failover. The SQLState of a given SQLException is evaluated to determine whether it begins with any value in the comma-delimited list.
  500. </Property>
  501. <Property name="loadBalanceValidateConnectionOnSwapServer" required="No" default="false" sortOrder="alpha" since="5.1.13">
  502. Should the load-balanced Connection explicitly check whether the connection is live when swapping to a new physical connection at commit/rollback?
  503. </Property>
  504. <Property name="maxRows" required="No" default="-1" sortOrder="alpha" since="all versions">
  505. The maximum number of rows to return (0, the default means return all rows).
  506. </Property>
  507. <Property name="netTimeoutForStreamingResults" required="No" default="600" sortOrder="alpha" since="5.1.0">
  508. What value should the driver automatically set the server setting 'net_write_timeout' to when the streaming result sets feature is in use? (value has unit of seconds, the value '0' means the driver will not try and adjust this value)
  509. </Property>
  510. <Property name="noAccessToProcedureBodies" required="No" default="false" sortOrder="alpha" since="5.0.3">
  511. When determining procedure parameter types for CallableStatements, and the connected user can't access procedure bodies through "SHOW CREATE PROCEDURE" or select on mysql.proc should the driver instead create basic metadata (all parameters reported as IN VARCHARs, but allowing registerOutParameter() to be called on them anyway) instead of throwing an exception?
  512. </Property>
  513. <Property name="noDatetimeStringSync" required="No" default="false" sortOrder="alpha" since="3.1.7">
  514. Don't ensure that ResultSet.getDatetimeType().toString().equals(ResultSet.getString())
  515. </Property>
  516. <Property name="noTimezoneConversionForDateType" required="No" default="true" sortOrder="alpha" since="5.1.35">
  517. Don't convert DATE values using the server time zone if 'useTimezone'='true' or 'useLegacyDatetimeCode'='false'
  518. </Property>
  519. <Property name="noTimezoneConversionForTimeType" required="No" default="false" sortOrder="alpha" since="5.0.0">
  520. Don't convert TIME values using the server time zone if 'useTimezone'='true'
  521. </Property>
  522. <Property name="nullCatalogMeansCurrent" required="No" default="true" sortOrder="alpha" since="3.1.8">
  523. When DatabaseMetadataMethods ask for a 'catalog' parameter, does the value null mean use the current catalog? (this is not JDBC-compliant, but follows legacy behavior from earlier versions of the driver)
  524. </Property>
  525. <Property name="nullNamePatternMatchesAll" required="No" default="true" sortOrder="alpha" since="3.1.8">
  526. Should DatabaseMetaData methods that accept *pattern parameters treat null the same as '%' (this is not JDBC-compliant, however older versions of the driver accepted this departure from the specification)
  527. </Property>
  528. <Property name="overrideSupportsIntegrityEnhancementFacility" required="No" default="false" sortOrder="alpha" since="3.1.12">
  529. Should the driver return "true" for DatabaseMetaData.supportsIntegrityEnhancementFacility() even if the database doesn't support it to workaround applications that require this method to return "true" to signal support of foreign keys, even though the SQL specification states that this facility contains much more than just foreign key support (one such application being OpenOffice)?
  530. </Property>
  531. <Property name="padCharsWithSpace" required="No" default="false" sortOrder="alpha" since="5.0.6">
  532. If a result set column has the CHAR type and the value does not fill the amount of characters specified in the DDL for the column, should the driver pad the remaining characters with space (for ANSI compliance)?
  533. </Property>
  534. <Property name="pedantic" required="No" default="false" sortOrder="alpha" since="3.0.0">
  535. Follow the JDBC spec to the letter.
  536. </Property>
  537. <Property name="pinGlobalTxToPhysicalConnection" required="No" default="false" sortOrder="alpha" since="5.0.1">
  538. When using XAConnections, should the driver ensure that operations on a given XID are always routed to the same physical connection? This allows the XAConnection to support "XA START ... JOIN" after "XA END" has been called
  539. </Property>
  540. <Property name="populateInsertRowWithDefaultValues" required="No" default="false" sortOrder="alpha" since="5.0.5">
  541. When using ResultSets that are CONCUR_UPDATABLE, should the driver pre-populate the "insert" row with default values from the DDL for the table used in the query so those values are immediately available for ResultSet accessors? This functionality requires a call to the database for metadata each time a result set of this type is created. If disabled (the default), the default values will be populated by the an internal call to refreshRow() which pulls back default values and/or values changed by triggers.
  542. </Property>
  543. <Property name="processEscapeCodesForPrepStmts" required="No" default="true" sortOrder="alpha" since="3.1.12">
  544. Should the driver process escape codes in queries that are prepared? Default escape processing behavior in non-prepared statements must be defined with the property 'enableEscapeProcessing'.
  545. </Property>
  546. <Property name="queryTimeoutKillsConnection" required="No" default="false" sortOrder="alpha" since="5.1.9">
  547. If the timeout given in Statement.setQueryTimeout() expires, should the driver forcibly abort the Connection instead of attempting to abort the query?
  548. </Property>
  549. <Property name="relaxAutoCommit" required="No" default="false" sortOrder="alpha" since="2.0.13">
  550. If the version of MySQL the driver connects to does not support transactions, still allow calls to commit(), rollback() and setAutoCommit() (true/false, defaults to 'false')?
  551. </Property>
  552. <Property name="retainStatementAfterResultSetClose" required="No" default="false" sortOrder="alpha" since="3.1.11">
  553. Should the driver retain the Statement reference in a ResultSet after ResultSet.close() has been called. This is not JDBC-compliant after JDBC-4.0.
  554. </Property>
  555. <Property name="rollbackOnPooledClose" required="No" default="true" sortOrder="alpha" since="3.0.15">
  556. Should the driver issue a rollback() when the logical connection in a pool is closed?
  557. </Property>
  558. <Property name="runningCTS13" required="No" default="false" sortOrder="alpha" since="3.1.7">
  559. Enables workarounds for bugs in Sun's JDBC compliance testsuite version 1.3
  560. </Property>
  561. <Property name="sendFractionalSeconds" required="No" default="true" sortOrder="alpha" since="5.1.37">
  562. Send fractional part from TIMESTAMP seconds. If set to false, the nanoseconds value of TIMESTAMP values will be truncated before sending any data to the server. This option applies only to prepared statements, callable statements or updatable result sets.
  563. </Property>
  564. <Property name="serverTimezone" required="No" default="" sortOrder="alpha" since="3.0.2">
  565. Override detection/mapping of time zone. Used when time zone from server doesn't map to Java time zone
  566. </Property>
  567. <Property name="statementInterceptors" required="No" default="" sortOrder="alpha" since="5.1.1">
  568. A comma-delimited list of classes that implement "com.mysql.jdbc.StatementInterceptor" that should be placed "in between" query execution to influence the results. StatementInterceptors are "chainable", the results returned by the "current" interceptor will be passed on to the next in in the chain, from left-to-right order, as specified in this property.
  569. </Property>
  570. <Property name="strictFloatingPoint" required="No" default="false" sortOrder="alpha" since="3.0.0">
  571. Used only in older versions of compliance test
  572. </Property>
  573. <Property name="strictUpdates" required="No" default="true" sortOrder="alpha" since="3.0.4">
  574. Should the driver do strict checking (all primary keys selected) of updatable result sets (true, false, defaults to 'true')?
  575. </Property>
  576. <Property name="tinyInt1isBit" required="No" default="true" sortOrder="alpha" since="3.0.16">
  577. Should the driver treat the datatype TINYINT(1) as the BIT type (because the server silently converts BIT -> TINYINT(1) when creating tables)?
  578. </Property>
  579. <Property name="transformedBitIsBoolean" required="No" default="false" sortOrder="alpha" since="3.1.9">
  580. If the driver converts TINYINT(1) to a different type, should it use BOOLEAN instead of BIT for future compatibility with MySQL-5.0, as MySQL-5.0 has a BIT type?
  581. </Property>
  582. <Property name="treatUtilDateAsTimestamp" required="No" default="true" sortOrder="alpha" since="5.0.5">
  583. Should the driver treat java.util.Date as a TIMESTAMP for the purposes of PreparedStatement.setObject()?
  584. </Property>
  585. <Property name="ultraDevHack" required="No" default="false" sortOrder="alpha" since="2.0.3">
  586. Create PreparedStatements for prepareCall() when required, because UltraDev is broken and issues a prepareCall() for _all_ statements? (true/false, defaults to 'false')
  587. </Property>
  588. <Property name="useAffectedRows" required="No" default="false" sortOrder="alpha" since="5.1.7">
  589. Don't set the CLIENT_FOUND_ROWS flag when connecting to the server (not JDBC-compliant, will break most applications that rely on "found" rows vs. "affected rows" for DML statements), but does cause "correct" update counts from "INSERT ... ON DUPLICATE KEY UPDATE" statements to be returned by the server.
  590. </Property>
  591. <Property name="useGmtMillisForDatetimes" required="No" default="false" sortOrder="alpha" since="3.1.12">
  592. Convert between session time zone and GMT before creating Date and Timestamp instances (value of 'false' leads to legacy behavior, 'true' leads to more JDBC-compliant behavior)? This is part of the legacy date-time code, thus the property has an effect only when "useLegacyDatetimeCode=true."
  593. </Property>
  594. <Property name="useHostsInPrivileges" required="No" default="true" sortOrder="alpha" since="3.0.2">
  595. Add '@hostname' to users in DatabaseMetaData.getColumn/TablePrivileges() (true/false), defaults to 'true'.
  596. </Property>
  597. <Property name="useInformationSchema" required="No" default="false" sortOrder="alpha" since="5.0.0">
  598. When connected to MySQL-5.0.7 or newer, should the driver use the INFORMATION_SCHEMA to derive information used by DatabaseMetaData?
  599. </Property>
  600. <Property name="useJDBCCompliantTimezoneShift" required="No" default="false" sortOrder="alpha" since="5.0.0">
  601. Should the driver use JDBC-compliant rules when converting TIME/TIMESTAMP/DATETIME values' time zone information for those JDBC arguments which take a java.util.Calendar argument? This is part of the legacy date-time code, thus the property has an effect only when "useLegacyDatetimeCode=true."
  602. </Property>
  603. <Property name="useLegacyDatetimeCode" required="No" default="true" sortOrder="alpha" since="5.1.6">
  604. Use code for DATE/TIME/DATETIME/TIMESTAMP handling in result sets and statements that consistently handles time zone conversions from client to server and back again, or use the legacy code for these datatypes that has been in the driver for backwards-compatibility? Setting this property to 'false' voids the effects of "useTimezone," "useJDBCCompliantTimezoneShift," "useGmtMillisForDatetimes," and "useFastDateParsing."
  605. </Property>
  606. <Property name="useOldAliasMetadataBehavior" required="No" default="false" sortOrder="alpha" since="5.0.4">
  607. Should the driver use the legacy behavior for "AS" clauses on columns and tables, and only return aliases (if any) for ResultSetMetaData.getColumnName() or ResultSetMetaData.getTableName() rather than the original column/table name? In 5.0.x, the default value was true.
  608. </Property>
  609. <Property name="useOldUTF8Behavior" required="No" default="false" sortOrder="alpha" since="3.1.6">
  610. Use the UTF-8 behavior the driver did when communicating with 4.0 and older servers
  611. </Property>
  612. <Property name="useOnlyServerErrorMessages" required="No" default="true" sortOrder="alpha" since="3.0.15">
  613. Don't prepend 'standard' SQLState error messages to error messages returned by the server.
  614. </Property>
  615. <Property name="useSSPSCompatibleTimezoneShift" required="No" default="false" sortOrder="alpha" since="5.0.5">
  616. If migrating from an environment that was using server-side prepared statements, and the configuration property "useJDBCCompliantTimeZoneShift" set to "true", use compatible behavior when not using server-side prepared statements when sending TIMESTAMP values to the MySQL server.
  617. </Property>
  618. <Property name="useServerPrepStmts" required="No" default="false" sortOrder="alpha" since="3.1.0">
  619. Use server-side prepared statements if the server supports them?
  620. </Property>
  621. <Property name="useSqlStateCodes" required="No" default="true" sortOrder="alpha" since="3.1.3">
  622. Use SQL Standard state codes instead of 'legacy' X/Open/SQL state codes (true/false), default is 'true'
  623. </Property>
  624. <Property name="useStreamLengthsInPrepStmts" required="No" default="true" sortOrder="alpha" since="3.0.2">
  625. Honor stream length parameter in PreparedStatement/ResultSet.setXXXStream() method calls (true/false, defaults to 'true')?
  626. </Property>
  627. <Property name="useTimezone" required="No" default="false" sortOrder="alpha" since="3.0.2">
  628. Convert time/date types between client and server time zones (true/false, defaults to 'false')? This is part of the legacy date-time code, thus the property has an effect only when "useLegacyDatetimeCode=true."
  629. </Property>
  630. <Property name="useUnbufferedInput" required="No" default="true" sortOrder="alpha" since="3.0.11">
  631. Don't use BufferedInputStream for reading data from the server
  632. </Property>
  633. <Property name="yearIsDateType" required="No" default="true" sortOrder="alpha" since="3.1.9">
  634. Should the JDBC driver treat the MySQL type "YEAR" as a java.sql.Date, or as a SHORT?
  635. </Property>
  636. <Property name="zeroDateTimeBehavior" required="No" default="exception" sortOrder="alpha" since="3.1.4">
  637. What should happen when the driver encounters DATETIME values that are composed entirely of zeros (used by MySQL to represent invalid dates)? Valid values are "exception", "round" and "convertToNull".
  638. </Property>
  639. </PropertyCategory>
  640. </ConnectionProperties>
Add Comment
Please, Sign In to add comment
Public Pastes
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!