Author: paul
Date: 2011-01-30 20:05:17 +0100 (Sun, 30 Jan 2011)
New Revision: 24952
Log:
r44566@dhcp-213: paul | 2011-01-30 13:04:51 -0500
Revert last change
Modified:
trunk/refman-common/connector-j-connprops.xml
trunk/refman-common/connector-j-errormap.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 07c7e7b4-24e3-4b51-89d0-6dc09fec6bec:/mysqldoc-local/mysqldoc/trunk:35498
07c7e7b4-24e3-4b51-89d0-6dc09fec6bec:/mysqldoc-local/trunk:46591
4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:43968
4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/trunk:44480
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:66486
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:39036
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/trunk:39546
ebeeeee4-b232-4669-a521-231442eced53:/mysqldoc-local/mysqldoc/trunk:44547
+ 07c7e7b4-24e3-4b51-89d0-6dc09fec6bec:/mysqldoc-local/mysqldoc/trunk:35498
07c7e7b4-24e3-4b51-89d0-6dc09fec6bec:/mysqldoc-local/trunk:46591
4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:43968
4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/trunk:44480
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:66486
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:39036
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/trunk:39546
ebeeeee4-b232-4669-a521-231442eced53:/mysqldoc-local/mysqldoc/trunk:44566
Modified: trunk/refman-common/connector-j-connprops.xml
===================================================================
--- trunk/refman-common/connector-j-connprops.xml 2011-01-30 18:40:05 UTC (rev 24951)
+++ trunk/refman-common/connector-j-connprops.xml 2011-01-30 19:05:17 UTC (rev 24952)
Changed blocks: 1, Lines Added: 1637, Lines Deleted: 1660; 156607 bytes
@@ -4,1692 +4,1669 @@
<!-- PLEASE DO NOT EDIT THIS FILE, IT IS AUTOMATICALLY GENERATED -->
<cjblock>
-<!DOCTYPE formalpara PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
+ <formalpara>
-<!-- PLEASE DO NOT EDIT THIS FILE, IT IS AUTOMATICALLY GENERATED -->
+ <title>Connection/Authentication</title>
- <cjblock>
+ <para>
+ <informaltable>
+ <tgroup cols="4">
+ <colspec colwidth="30*" colname="cj_propstbl_prop_name"/>
+ <colspec colwidth="50*" colname="cj_propstbl_prop_defn"/>
+ <colspec colwidth="10*" colname="cj_propstbl_default"/>
+ <colspec colwidth="10*" colname="cj_propstbl_since_version"/>
+ <tbody>
+ <row>
+ <entry><emphasis role="bold"> Property Name </emphasis></entry>
+ <entry><emphasis role="bold"> Definition </emphasis></entry>
+ <entry><emphasis role="bold"> Default Value </emphasis></entry>
+ <entry><emphasis role="bold"> Since Version </emphasis></entry>
+ </row>
+ <row>
+ <entry>user</entry>
+ <entry>The user to connect as</entry>
+ <entry/>
+ <entry>all versions</entry>
+ </row>
+ <row>
+ <entry>password</entry>
+ <entry>The password to use when connecting</entry>
+ <entry/>
+ <entry>all versions</entry>
+ </row>
+ <row>
+ <entry>socketFactory</entry>
+ <entry>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.</entry>
+ <entry>com.mysql.jdbc.StandardSocketFactory</entry>
+ <entry>3.0.3</entry>
+ </row>
+ <row>
+ <entry>connectTimeout</entry>
+ <entry>Timeout for socket connect (in milliseconds), with 0 being no timeout.
+ Only works on JDK-1.4 or newer. Defaults to '0'.</entry>
+ <entry>0</entry>
+ <entry>3.0.1</entry>
+ </row>
+ <row>
+ <entry>socketTimeout</entry>
+ <entry>Timeout on network socket operations (0, the default means no timeout).</entry>
+ <entry>0</entry>
+ <entry>3.0.1</entry>
+ </row>
+ <row>
+ <entry>connectionLifecycleInterceptors</entry>
+ <entry>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.</entry>
+ <entry/>
+ <entry>5.1.4</entry>
+ </row>
+ <row>
+ <entry>useConfigs</entry>
+ <entry>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.</entry>
+ <entry/>
+ <entry>3.1.5</entry>
+ </row>
+ <row>
+ <entry>interactiveClient</entry>
+ <entry>Set the CLIENT_INTERACTIVE flag, which tells MySQL to timeout
+ connections based on INTERACTIVE_TIMEOUT instead of
+ WAIT_TIMEOUT</entry>
+ <entry>false</entry>
+ <entry>3.1.0</entry>
+ </row>
+ <row>
+ <entry>localSocketAddress</entry>
+ <entry>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.</entry>
+ <entry/>
+ <entry>5.0.5</entry>
+ </row>
+ <row>
+ <entry>propertiesTransform</entry>
+ <entry>An implementation of com.mysql.jdbc.ConnectionPropertiesTransform that
+ the driver will use to modify URL properties passed to
+ the driver before attempting a connection</entry>
+ <entry/>
+ <entry>3.1.4</entry>
+ </row>
+ <row>
+ <entry>useCompression</entry>
+ <entry>Use zlib compression when communicating with the server (true/false)?
+ Defaults to 'false'.</entry>
+ <entry>false</entry>
+ <entry>3.0.17</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
- <formalpara>
+ </formalpara>
- <title>Connection/Authentication</title>
+ <formalpara>
- <para>
- <informaltable>
- <tgroup cols="4">
- <colspec colwidth="30*" colname="cj_propstbl_prop_name"/>
- <colspec colwidth="50*" colname="cj_propstbl_prop_defn"/>
- <colspec colwidth="10*" colname="cj_propstbl_default"/>
- <colspec colwidth="10*" colname="cj_propstbl_since_version"/>
- <tbody>
- <row>
- <entry><emphasis role="bold"> Property Name </emphasis></entry>
- <entry><emphasis role="bold"> Definition </emphasis></entry>
- <entry><emphasis role="bold"> Default Value </emphasis></entry>
- <entry><emphasis role="bold"> Since Version </emphasis></entry>
- </row>
- <row>
- <entry>user</entry>
- <entry>The user to connect as</entry>
- <entry/>
- <entry>all versions</entry>
- </row>
- <row>
- <entry>password</entry>
- <entry>The password to use when connecting</entry>
- <entry/>
- <entry>all versions</entry>
- </row>
- <row>
- <entry>socketFactory</entry>
- <entry>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.</entry>
- <entry>com.mysql.jdbc.StandardSocketFactory</entry>
- <entry>3.0.3</entry>
- </row>
- <row>
- <entry>connectTimeout</entry>
- <entry>Timeout for socket connect (in milliseconds), with 0 being no timeout.
- Only works on JDK-1.4 or newer. Defaults to '0'.</entry>
- <entry>0</entry>
- <entry>3.0.1</entry>
- </row>
- <row>
- <entry>socketTimeout</entry>
- <entry>Timeout on network socket operations (0, the default means no timeout).</entry>
- <entry>0</entry>
- <entry>3.0.1</entry>
- </row>
- <row>
- <entry>connectionLifecycleInterceptors</entry>
- <entry>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.</entry>
- <entry/>
- <entry>5.1.4</entry>
- </row>
- <row>
- <entry>useConfigs</entry>
- <entry>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.</entry>
- <entry/>
- <entry>3.1.5</entry>
- </row>
- <row>
- <entry>interactiveClient</entry>
- <entry>Set the CLIENT_INTERACTIVE flag, which tells MySQL to timeout
- connections based on INTERACTIVE_TIMEOUT instead of
- WAIT_TIMEOUT</entry>
- <entry>false</entry>
- <entry>3.1.0</entry>
- </row>
- <row>
- <entry>localSocketAddress</entry>
- <entry>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.</entry>
- <entry/>
- <entry>5.0.5</entry>
- </row>
- <row>
- <entry>propertiesTransform</entry>
- <entry>An implementation of com.mysql.jdbc.ConnectionPropertiesTransform that
- the driver will use to modify URL properties passed to
- the driver before attempting a connection</entry>
- <entry/>
- <entry>3.1.4</entry>
- </row>
- <row>
- <entry>useCompression</entry>
- <entry>Use zlib compression when communicating with the server (true/false)?
- Defaults to 'false'.</entry>
- <entry>false</entry>
- <entry>3.0.17</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <title>Networking</title>
- </formalpara>
+ <para>
+ <informaltable>
+ <tgroup cols="4">
+ <colspec colwidth="30*" colname="cj_propstbl_prop_name"/>
+ <colspec colwidth="50*" colname="cj_propstbl_prop_defn"/>
+ <colspec colwidth="10*" colname="cj_propstbl_default"/>
+ <colspec colwidth="10*" colname="cj_propstbl_since_version"/>
+ <tbody>
+ <row>
+ <entry><emphasis role="bold"> Property Name </emphasis></entry>
+ <entry><emphasis role="bold"> Definition </emphasis></entry>
+ <entry><emphasis role="bold"> Default Value </emphasis></entry>
+ <entry><emphasis role="bold"> Since Version </emphasis></entry>
+ </row>
+ <row>
+ <entry>maxAllowedPacket</entry>
+ <entry>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'.</entry>
+ <entry>-1</entry>
+ <entry>5.1.8</entry>
+ </row>
+ <row>
+ <entry>tcpKeepAlive</entry>
+ <entry>If connecting using TCP/IP, should the driver set SO_KEEPALIVE?</entry>
+ <entry>true</entry>
+ <entry>5.0.7</entry>
+ </row>
+ <row>
+ <entry>tcpNoDelay</entry>
+ <entry>If connecting using TCP/IP, should the driver set SO_TCP_NODELAY
+ (disabling the Nagle Algorithm)?</entry>
+ <entry>true</entry>
+ <entry>5.0.7</entry>
+ </row>
+ <row>
+ <entry>tcpRcvBuf</entry>
+ <entry>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)</entry>
+ <entry>0</entry>
+ <entry>5.0.7</entry>
+ </row>
+ <row>
+ <entry>tcpSndBuf</entry>
+ <entry>If connecting using TCP/IP, shuold the driver set SO_SND_BUF to the
+ given value? The default value of '0', means use the
+ platform default value for this property)</entry>
+ <entry>0</entry>
+ <entry>5.0.7</entry>
+ </row>
+ <row>
+ <entry>tcpTrafficClass</entry>
+ <entry>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.</entry>
+ <entry>0</entry>
+ <entry>5.0.7</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
- <formalpara>
+ </formalpara>
- <title>Networking</title>
+ <formalpara>
- <para>
- <informaltable>
- <tgroup cols="4">
- <colspec colwidth="30*" colname="cj_propstbl_prop_name"/>
- <colspec colwidth="50*" colname="cj_propstbl_prop_defn"/>
- <colspec colwidth="10*" colname="cj_propstbl_default"/>
- <colspec colwidth="10*" colname="cj_propstbl_since_version"/>
- <tbody>
- <row>
- <entry><emphasis role="bold"> Property Name </emphasis></entry>
- <entry><emphasis role="bold"> Definition </emphasis></entry>
- <entry><emphasis role="bold"> Default Value </emphasis></entry>
- <entry><emphasis role="bold"> Since Version </emphasis></entry>
- </row>
- <row>
- <entry>maxAllowedPacket</entry>
- <entry>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'.</entry>
- <entry>-1</entry>
- <entry>5.1.8</entry>
- </row>
- <row>
- <entry>tcpKeepAlive</entry>
- <entry>If connecting using TCP/IP, should the driver set SO_KEEPALIVE?</entry>
- <entry>true</entry>
- <entry>5.0.7</entry>
- </row>
- <row>
- <entry>tcpNoDelay</entry>
- <entry>If connecting using TCP/IP, should the driver set SO_TCP_NODELAY
- (disabling the Nagle Algorithm)?</entry>
- <entry>true</entry>
- <entry>5.0.7</entry>
- </row>
- <row>
- <entry>tcpRcvBuf</entry>
- <entry>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)</entry>
- <entry>0</entry>
- <entry>5.0.7</entry>
- </row>
- <row>
- <entry>tcpSndBuf</entry>
- <entry>If connecting using TCP/IP, shuold the driver set SO_SND_BUF to the
- given value? The default value of '0', means use the
- platform default value for this property)</entry>
- <entry>0</entry>
- <entry>5.0.7</entry>
- </row>
- <row>
- <entry>tcpTrafficClass</entry>
- <entry>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.</entry>
- <entry>0</entry>
- <entry>5.0.7</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <title>High Availability and Clustering</title>
- </formalpara>
+ <para>
+ <informaltable>
+ <tgroup cols="4">
+ <colspec colwidth="30*" colname="cj_propstbl_prop_name"/>
+ <colspec colwidth="50*" colname="cj_propstbl_prop_defn"/>
+ <colspec colwidth="10*" colname="cj_propstbl_default"/>
+ <colspec colwidth="10*" colname="cj_propstbl_since_version"/>
+ <tbody>
+ <row>
+ <entry><emphasis role="bold"> Property Name </emphasis></entry>
+ <entry><emphasis role="bold"> Definition </emphasis></entry>
+ <entry><emphasis role="bold"> Default Value </emphasis></entry>
+ <entry><emphasis role="bold"> Since Version </emphasis></entry>
+ </row>
+ <row>
+ <entry>autoReconnect</entry>
+ <entry>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, investigate setting
+ the MySQL server variable "wait_timeout" to some high
+ value rather than the default of 8 hours.</entry>
+ <entry>false</entry>
+ <entry>1.1</entry>
+ </row>
+ <row>
+ <entry>autoReconnectForPools</entry>
+ <entry>Use a reconnection strategy appropriate for connection pools (defaults
+ to 'false')</entry>
+ <entry>false</entry>
+ <entry>3.1.3</entry>
+ </row>
+ <row>
+ <entry>failOverReadOnly</entry>
+ <entry>When failing over in autoReconnect mode, should the connection be set to
+ 'read-only'?</entry>
+ <entry>true</entry>
+ <entry>3.0.12</entry>
+ </row>
+ <row>
+ <entry>maxReconnects</entry>
+ <entry>Maximum number of reconnects to attempt if autoReconnect is true,
+ default is '3'.</entry>
+ <entry>3</entry>
+ <entry>1.1</entry>
+ </row>
+ <row>
+ <entry>reconnectAtTxEnd</entry>
+ <entry>If autoReconnect is set to true, should the driver attempt reconnections
+ at the end of every transaction?</entry>
+ <entry>false</entry>
+ <entry>3.0.10</entry>
+ </row>
+ <row>
+ <entry>retriesAllDown</entry>
+ <entry>When using loadbalancing, 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.</entry>
+ <entry>120</entry>
+ <entry>5.1.6</entry>
+ </row>
+ <row>
+ <entry>initialTimeout</entry>
+ <entry>If autoReconnect is enabled, the initial time to wait between re-connect
+ attempts (in seconds, defaults to '2').</entry>
+ <entry>2</entry>
+ <entry>1.1</entry>
+ </row>
+ <row>
+ <entry>roundRobinLoadBalance</entry>
+ <entry>When autoReconnect is enabled, and failoverReadonly is false, should we
+ pick hosts to connect to on a round-robin basis?</entry>
+ <entry>false</entry>
+ <entry>3.1.2</entry>
+ </row>
+ <row>
+ <entry>queriesBeforeRetryMaster</entry>
+ <entry>Number of queries to issue before falling back to master 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 master. Defaults to 50.</entry>
+ <entry>50</entry>
+ <entry>3.0.2</entry>
+ </row>
+ <row>
+ <entry>secondsBeforeRetryMaster</entry>
+ <entry>How long should the driver wait, when failed over, before attempting</entry>
+ <entry>30</entry>
+ <entry>3.0.2</entry>
+ </row>
+ <row>
+ <entry>selfDestructOnPingMaxOperations</entry>
+ <entry>=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 connnection's
+ count of commands sent to the server exceeds this value.</entry>
+ <entry>0</entry>
+ <entry>5.1.6</entry>
+ </row>
+ <row>
+ <entry>selfDestructOnPingSecondsLifetime</entry>
+ <entry>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 connnection's
+ lifetime exceeds this value.</entry>
+ <entry>0</entry>
+ <entry>5.1.6</entry>
+ </row>
+ <row>
+ <entry>resourceId</entry>
+ <entry>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</entry>
+ <entry/>
+ <entry>5.0.1</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
- <formalpara>
+ </formalpara>
- <title>High Availability and Clustering</title>
+ <formalpara>
- <para>
- <informaltable>
- <tgroup cols="4">
- <colspec colwidth="30*" colname="cj_propstbl_prop_name"/>
- <colspec colwidth="50*" colname="cj_propstbl_prop_defn"/>
- <colspec colwidth="10*" colname="cj_propstbl_default"/>
- <colspec colwidth="10*" colname="cj_propstbl_since_version"/>
- <tbody>
- <row>
- <entry><emphasis role="bold"> Property Name </emphasis></entry>
- <entry><emphasis role="bold"> Definition </emphasis></entry>
- <entry><emphasis role="bold"> Default Value </emphasis></entry>
- <entry><emphasis role="bold"> Since Version </emphasis></entry>
- </row>
- <row>
- <entry>autoReconnect</entry>
- <entry>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, investigate setting the MySQL server
- variable "wait_timeout" to some high value rather than
- the default of 8 hours.</entry>
- <entry>false</entry>
- <entry>1.1</entry>
- </row>
- <row>
- <entry>autoReconnectForPools</entry>
- <entry>Use a reconnection strategy appropriate for connection pools (defaults
- to 'false')</entry>
- <entry>false</entry>
- <entry>3.1.3</entry>
- </row>
- <row>
- <entry>failOverReadOnly</entry>
- <entry>When failing over in autoReconnect mode, should the connection be set to
- 'read-only'?</entry>
- <entry>true</entry>
- <entry>3.0.12</entry>
- </row>
- <row>
- <entry>maxReconnects</entry>
- <entry>Maximum number of reconnects to attempt if autoReconnect is true,
- default is '3'.</entry>
- <entry>3</entry>
- <entry>1.1</entry>
- </row>
- <row>
- <entry>reconnectAtTxEnd</entry>
- <entry>If autoReconnect is set to true, should the driver attempt reconnections
- at the end of every transaction?</entry>
- <entry>false</entry>
- <entry>3.0.10</entry>
- </row>
- <row>
- <entry>retriesAllDown</entry>
- <entry>When using loadbalancing, 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.</entry>
- <entry>120</entry>
- <entry>5.1.6</entry>
- </row>
- <row>
- <entry>initialTimeout</entry>
- <entry>If autoReconnect is enabled, the initial time to wait between re-connect
- attempts (in seconds, defaults to '2').</entry>
- <entry>2</entry>
- <entry>1.1</entry>
- </row>
- <row>
- <entry>roundRobinLoadBalance</entry>
- <entry>When autoReconnect is enabled, and failoverReadonly is false, should we
- pick hosts to connect to on a round-robin basis?</entry>
- <entry>false</entry>
- <entry>3.1.2</entry>
- </row>
- <row>
- <entry>queriesBeforeRetryMaster</entry>
- <entry>Number of queries to issue before falling back to master 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 master. Defaults to 50.</entry>
- <entry>50</entry>
- <entry>3.0.2</entry>
- </row>
- <row>
- <entry>secondsBeforeRetryMaster</entry>
- <entry>How long should the driver wait, when failed over, before attempting</entry>
- <entry>30</entry>
- <entry>3.0.2</entry>
- </row>
- <row>
- <entry>selfDestructOnPingMaxOperations</entry>
- <entry>=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 connnection's
- count of commands sent to the server exceeds this
- value.</entry>
- <entry>0</entry>
- <entry>5.1.6</entry>
- </row>
- <row>
- <entry>selfDestructOnPingSecondsLifetime</entry>
- <entry>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 connnection's
- lifetime exceeds this value.</entry>
- <entry>0</entry>
- <entry>5.1.6</entry>
- </row>
- <row>
- <entry>resourceId</entry>
- <entry>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</entry>
- <entry/>
- <entry>5.0.1</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <title>Security</title>
- </formalpara>
+ <para>
+ <informaltable>
+ <tgroup cols="4">
+ <colspec colwidth="30*" colname="cj_propstbl_prop_name"/>
+ <colspec colwidth="50*" colname="cj_propstbl_prop_defn"/>
+ <colspec colwidth="10*" colname="cj_propstbl_default"/>
+ <colspec colwidth="10*" colname="cj_propstbl_since_version"/>
+ <tbody>
+ <row>
+ <entry><emphasis role="bold"> Property Name </emphasis></entry>
+ <entry><emphasis role="bold"> Definition </emphasis></entry>
+ <entry><emphasis role="bold"> Default Value </emphasis></entry>
+ <entry><emphasis role="bold"> Since Version </emphasis></entry>
+ </row>
+ <row>
+ <entry>allowMultiQueries</entry>
+ <entry>Allow the use of ';' to delimit multiple queries during one statement
+ (true/false), defaults to 'false'</entry>
+ <entry>false</entry>
+ <entry>3.1.1</entry>
+ </row>
+ <row>
+ <entry>useSSL</entry>
+ <entry>Use SSL when communicating with the server (true/false), defaults to
+ 'false'</entry>
+ <entry>false</entry>
+ <entry>3.0.2</entry>
+ </row>
+ <row>
+ <entry>requireSSL</entry>
+ <entry>Require SSL connection if useSSL=true? (defaults to 'false').</entry>
+ <entry>false</entry>
+ <entry>3.1.0</entry>
+ </row>
+ <row>
+ <entry>verifyServerCertificate</entry>
+ <entry>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.</entry>
+ <entry>true</entry>
+ <entry>5.1.6</entry>
+ </row>
+ <row>
+ <entry>clientCertificateKeyStoreUrl</entry>
+ <entry>URL to the client certificate KeyStore (if not specified, use defaults)</entry>
+ <entry/>
+ <entry>5.1.0</entry>
+ </row>
+ <row>
+ <entry>clientCertificateKeyStoreType</entry>
+ <entry>KeyStore type for client certificates (NULL or empty means use default,
+ 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.</entry>
+ <entry/>
+ <entry>5.1.0</entry>
+ </row>
+ <row>
+ <entry>clientCertificateKeyStorePassword</entry>
+ <entry>Password for the client certificates KeyStore</entry>
+ <entry/>
+ <entry>5.1.0</entry>
+ </row>
+ <row>
+ <entry>trustCertificateKeyStoreUrl</entry>
+ <entry>URL to the trusted root certificate KeyStore (if not specified, use
+ defaults)</entry>
+ <entry/>
+ <entry>5.1.0</entry>
+ </row>
+ <row>
+ <entry>trustCertificateKeyStoreType</entry>
+ <entry>KeyStore type for trusted root certificates (NULL or empty means use
+ default, 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.</entry>
+ <entry/>
+ <entry>5.1.0</entry>
+ </row>
+ <row>
+ <entry>trustCertificateKeyStorePassword</entry>
+ <entry>Password for the trusted root certificates KeyStore</entry>
+ <entry/>
+ <entry>5.1.0</entry>
+ </row>
+ <row>
+ <entry>allowLoadLocalInfile</entry>
+ <entry>Should the driver allow use of 'LOAD DATA LOCAL INFILE...' (defaults to
+ 'true').</entry>
+ <entry>true</entry>
+ <entry>3.0.3</entry>
+ </row>
+ <row>
+ <entry>allowUrlInLocalInfile</entry>
+ <entry>Should the driver allow URLs in 'LOAD DATA LOCAL INFILE' statements?</entry>
+ <entry>false</entry>
+ <entry>3.1.4</entry>
+ </row>
+ <row>
+ <entry>paranoid</entry>
+ <entry>Take measures to prevent exposure sensitive information in error
+ messages and clear data structures holding sensitive
+ data when possible? (defaults to 'false')</entry>
+ <entry>false</entry>
+ <entry>3.0.1</entry>
+ </row>
+ <row>
+ <entry>passwordCharacterEncoding</entry>
+ <entry>What character encoding is used for passwords? Leaving this set to the
+ default value (null), uses the platform character set,
+ which works for ISO8859_1 (i.e. "latin1") passwords. For
+ passwords in other character encodings, the encoding
+ will have to be specified with this property, as it's
+ not possible for the driver to auto-detect this.</entry>
+ <entry/>
+ <entry>5.1.7</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
- <formalpara>
+ </formalpara>
- <title>Security</title>
+ <formalpara>
- <para>
- <informaltable>
- <tgroup cols="4">
- <colspec colwidth="30*" colname="cj_propstbl_prop_name"/>
- <colspec colwidth="50*" colname="cj_propstbl_prop_defn"/>
- <colspec colwidth="10*" colname="cj_propstbl_default"/>
- <colspec colwidth="10*" colname="cj_propstbl_since_version"/>
- <tbody>
- <row>
- <entry><emphasis role="bold"> Property Name </emphasis></entry>
- <entry><emphasis role="bold"> Definition </emphasis></entry>
- <entry><emphasis role="bold"> Default Value </emphasis></entry>
- <entry><emphasis role="bold"> Since Version </emphasis></entry>
- </row>
- <row>
- <entry>allowMultiQueries</entry>
- <entry>Allow the use of ';' to delimit multiple queries during one statement
- (true/false), defaults to 'false'</entry>
- <entry>false</entry>
- <entry>3.1.1</entry>
- </row>
- <row>
- <entry>useSSL</entry>
- <entry>Use SSL when communicating with the server (true/false), defaults to
- 'false'</entry>
- <entry>false</entry>
- <entry>3.0.2</entry>
- </row>
- <row>
- <entry>requireSSL</entry>
- <entry>Require SSL connection if useSSL=true? (defaults to 'false').</entry>
- <entry>false</entry>
- <entry>3.1.0</entry>
- </row>
- <row>
- <entry>verifyServerCertificate</entry>
- <entry>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.</entry>
- <entry>true</entry>
- <entry>5.1.6</entry>
- </row>
- <row>
- <entry>clientCertificateKeyStoreUrl</entry>
- <entry>URL to the client certificate KeyStore (if not specified, use defaults)</entry>
- <entry/>
- <entry>5.1.0</entry>
- </row>
- <row>
- <entry>clientCertificateKeyStoreType</entry>
- <entry>KeyStore type for client certificates (NULL or empty means use default,
- 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.</entry>
- <entry/>
- <entry>5.1.0</entry>
- </row>
- <row>
- <entry>clientCertificateKeyStorePassword</entry>
- <entry>Password for the client certificates KeyStore</entry>
- <entry/>
- <entry>5.1.0</entry>
- </row>
- <row>
- <entry>trustCertificateKeyStoreUrl</entry>
- <entry>URL to the trusted root certificate KeyStore (if not specified, use
- defaults)</entry>
- <entry/>
- <entry>5.1.0</entry>
- </row>
- <row>
- <entry>trustCertificateKeyStoreType</entry>
- <entry>KeyStore type for trusted root certificates (NULL or empty means use
- default, 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.</entry>
- <entry/>
- <entry>5.1.0</entry>
- </row>
- <row>
- <entry>trustCertificateKeyStorePassword</entry>
- <entry>Password for the trusted root certificates KeyStore</entry>
- <entry/>
- <entry>5.1.0</entry>
- </row>
- <row>
- <entry>allowLoadLocalInfile</entry>
- <entry>Should the driver allow use of 'LOAD DATA LOCAL INFILE...' (defaults to
- 'true').</entry>
- <entry>true</entry>
- <entry>3.0.3</entry>
- </row>
- <row>
- <entry>allowUrlInLocalInfile</entry>
- <entry>Should the driver allow URLs in 'LOAD DATA LOCAL INFILE' statements?</entry>
- <entry>false</entry>
- <entry>3.1.4</entry>
- </row>
- <row>
- <entry>paranoid</entry>
- <entry>Take measures to prevent exposure sensitive information in error
- messages and clear data structures holding sensitive
- data when possible? (defaults to 'false')</entry>
- <entry>false</entry>
- <entry>3.0.1</entry>
- </row>
- <row>
- <entry>passwordCharacterEncoding</entry>
- <entry>What character encoding is used for passwords? Leaving this set to the
- default value (null), uses the platform character set,
- which works for ISO8859_1 (i.e. "latin1") passwords.
- For passwords in other character encodings, the
- encoding will have to be specified with this property,
- as it's not possible for the driver to auto-detect
- this.</entry>
- <entry/>
- <entry>5.1.7</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <title>Performance Extensions</title>
- </formalpara>
+ <para>
+ <informaltable>
+ <tgroup cols="4">
+ <colspec colwidth="30*" colname="cj_propstbl_prop_name"/>
+ <colspec colwidth="50*" colname="cj_propstbl_prop_defn"/>
+ <colspec colwidth="10*" colname="cj_propstbl_default"/>
+ <colspec colwidth="10*" colname="cj_propstbl_since_version"/>
+ <tbody>
+ <row>
+ <entry><emphasis role="bold"> Property Name </emphasis></entry>
+ <entry><emphasis role="bold"> Definition </emphasis></entry>
+ <entry><emphasis role="bold"> Default Value </emphasis></entry>
+ <entry><emphasis role="bold"> Since Version </emphasis></entry>
+ </row>
+ <row>
+ <entry>callableStmtCacheSize</entry>
+ <entry>If 'cacheCallableStmts' is enabled, how many callable statements should
+ be cached?</entry>
+ <entry>100</entry>
+ <entry>3.1.2</entry>
+ </row>
+ <row>
+ <entry>metadataCacheSize</entry>
+ <entry>The number of queries to cache ResultSetMetadata for if
+ cacheResultSetMetaData is set to 'true' (default 50)</entry>
+ <entry>50</entry>
+ <entry>3.1.1</entry>
+ </row>
+ <row>
+ <entry>useLocalSessionState</entry>
+ <entry>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?</entry>
+ <entry>false</entry>
+ <entry>3.1.7</entry>
+ </row>
+ <row>
+ <entry>useLocalTransactionState</entry>
+ <entry>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?</entry>
+ <entry>false</entry>
+ <entry>5.1.7</entry>
+ </row>
+ <row>
+ <entry>prepStmtCacheSize</entry>
+ <entry>If prepared statement caching is enabled, how many prepared statements
+ should be cached?</entry>
+ <entry>25</entry>
+ <entry>3.0.10</entry>
+ </row>
+ <row>
+ <entry>prepStmtCacheSqlLimit</entry>
+ <entry>If prepared statement caching is enabled, what's the largest SQL the
+ driver will cache the parsing for?</entry>
+ <entry>256</entry>
+ <entry>3.0.10</entry>
+ </row>
+ <row>
+ <entry>alwaysSendSetIsolation</entry>
+ <entry>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.</entry>
+ <entry>true</entry>
+ <entry>3.1.7</entry>
+ </row>
+ <row>
+ <entry>maintainTimeStats</entry>
+ <entry>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.</entry>
+ <entry>true</entry>
+ <entry>3.1.9</entry>
+ </row>
+ <row>
+ <entry>useCursorFetch</entry>
+ <entry>If connected to MySQL > 5.0.2, and setFetchSize() > 0 on a
+ statement, should that statement use cursor-based
+ fetching to retrieve rows?</entry>
+ <entry>false</entry>
+ <entry>5.0.0</entry>
+ </row>
+ <row>
+ <entry>blobSendChunkSize</entry>
+ <entry>Chunk to use when sending BLOB/CLOBs via ServerPreparedStatements</entry>
+ <entry>1048576</entry>
+ <entry>3.1.9</entry>
+ </row>
+ <row>
+ <entry>cacheCallableStmts</entry>
+ <entry>Should the driver cache the parsing stage of CallableStatements</entry>
+ <entry>false</entry>
+ <entry>3.1.2</entry>
+ </row>
+ <row>
+ <entry>cachePrepStmts</entry>
+ <entry>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?</entry>
+ <entry>false</entry>
+ <entry>3.0.10</entry>
+ </row>
+ <row>
+ <entry>cacheResultSetMetadata</entry>
+ <entry>Should the driver cache ResultSetMetaData for Statements and
+ PreparedStatements? (Req. JDK-1.4+, true/false, default
+ 'false')</entry>
+ <entry>false</entry>
+ <entry>3.1.1</entry>
+ </row>
+ <row>
+ <entry>cacheServerConfiguration</entry>
+ <entry>Should the driver cache the results of 'SHOW VARIABLES' and 'SHOW
+ COLLATION' on a per-URL basis?</entry>
+ <entry>false</entry>
+ <entry>3.1.5</entry>
+ </row>
+ <row>
+ <entry>defaultFetchSize</entry>
+ <entry>The driver will call setFetchSize(n) with this value on all
+ newly-created Statements</entry>
+ <entry>0</entry>
+ <entry>3.1.9</entry>
+ </row>
+ <row>
+ <entry>dontTrackOpenResources</entry>
+ <entry>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.</entry>
+ <entry>false</entry>
+ <entry>3.1.7</entry>
+ </row>
+ <row>
+ <entry>dynamicCalendars</entry>
+ <entry>Should the driver retrieve the default calendar when required, or cache
+ it per connection/session?</entry>
+ <entry>false</entry>
+ <entry>3.1.5</entry>
+ </row>
+ <row>
+ <entry>elideSetAutoCommits</entry>
+ <entry>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)?</entry>
+ <entry>false</entry>
+ <entry>3.1.3</entry>
+ </row>
+ <row>
+ <entry>enableQueryTimeouts</entry>
+ <entry>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.</entry>
+ <entry>true</entry>
+ <entry>5.0.6</entry>
+ </row>
+ <row>
+ <entry>holdResultsOpenOverStatementClose</entry>
+ <entry>Should the driver leave the result sets open on Statement.close()
+ (enabling violates JDBC specification)</entry>
+ <entry>false</entry>
+ <entry>3.1.7</entry>
+ </row>
+ <row>
+ <entry>largeRowSizeThreshold</entry>
+ <entry>What size result set row should the JDBC driver consider "large", and
+ thus use a more memory-efficient way of representing the
+ row internally?</entry>
+ <entry>2048</entry>
+ <entry>5.1.1</entry>
+ </row>
+ <row>
+ <entry>loadBalanceStrategy</entry>
+ <entry>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.</entry>
+ <entry>random</entry>
+ <entry>5.0.6</entry>
+ </row>
+ <row>
+ <entry>locatorFetchBufferSize</entry>
+ <entry>If 'emulateLocators' is configured to 'true', what size buffer should be
+ used when fetching BLOB data for getBinaryInputStream?</entry>
+ <entry>1048576</entry>
+ <entry>3.2.1</entry>
+ </row>
+ <row>
+ <entry>rewriteBatchedStatements</entry>
+ <entry>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.</entry>
+ <entry>false</entry>
+ <entry>3.1.13</entry>
+ </row>
+ <row>
+ <entry>useDirectRowUnpack</entry>
+ <entry>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.</entry>
+ <entry>true</entry>
+ <entry>5.1.1</entry>
+ </row>
+ <row>
+ <entry>useDynamicCharsetInfo</entry>
+ <entry>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?</entry>
+ <entry>true</entry>
+ <entry>5.0.6</entry>
+ </row>
+ <row>
+ <entry>useFastDateParsing</entry>
+ <entry>Use internal String->Date/Time/Timestamp conversion routines to avoid
+ excessive object creation?</entry>
+ <entry>true</entry>
+ <entry>5.0.5</entry>
+ </row>
+ <row>
+ <entry>useFastIntParsing</entry>
+ <entry>Use internal String->Integer conversion routines to avoid excessive
+ object creation?</entry>
+ <entry>true</entry>
+ <entry>3.1.4</entry>
+ </row>
+ <row>
+ <entry>useJvmCharsetConverters</entry>
+ <entry>Always use the character encoding routines built into the JVM, rather
+ than using lookup tables for single-byte character sets?</entry>
+ <entry>false</entry>
+ <entry>5.0.1</entry>
+ </row>
+ <row>
+ <entry>useReadAheadInput</entry>
+ <entry>Use newer, optimized non-blocking, buffered input stream when reading
+ from the server?</entry>
+ <entry>true</entry>
+ <entry>3.1.5</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
- <formalpara>
+ </formalpara>
- <title>Performance Extensions</title>
+ <formalpara>
- <para>
- <informaltable>
- <tgroup cols="4">
- <colspec colwidth="30*" colname="cj_propstbl_prop_name"/>
- <colspec colwidth="50*" colname="cj_propstbl_prop_defn"/>
- <colspec colwidth="10*" colname="cj_propstbl_default"/>
- <colspec colwidth="10*" colname="cj_propstbl_since_version"/>
- <tbody>
- <row>
- <entry><emphasis role="bold"> Property Name </emphasis></entry>
- <entry><emphasis role="bold"> Definition </emphasis></entry>
- <entry><emphasis role="bold"> Default Value </emphasis></entry>
- <entry><emphasis role="bold"> Since Version </emphasis></entry>
- </row>
- <row>
- <entry>callableStmtCacheSize</entry>
- <entry>If 'cacheCallableStmts' is enabled, how many callable statements should
- be cached?</entry>
- <entry>100</entry>
- <entry>3.1.2</entry>
- </row>
- <row>
- <entry>metadataCacheSize</entry>
- <entry>The number of queries to cache ResultSetMetadata for if
- cacheResultSetMetaData is set to 'true' (default 50)</entry>
- <entry>50</entry>
- <entry>3.1.1</entry>
- </row>
- <row>
- <entry>useLocalSessionState</entry>
- <entry>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?</entry>
- <entry>false</entry>
- <entry>3.1.7</entry>
- </row>
- <row>
- <entry>useLocalTransactionState</entry>
- <entry>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?</entry>
- <entry>false</entry>
- <entry>5.1.7</entry>
- </row>
- <row>
- <entry>prepStmtCacheSize</entry>
- <entry>If prepared statement caching is enabled, how many prepared statements
- should be cached?</entry>
- <entry>25</entry>
- <entry>3.0.10</entry>
- </row>
- <row>
- <entry>prepStmtCacheSqlLimit</entry>
- <entry>If prepared statement caching is enabled, what's the largest SQL the
- driver will cache the parsing for?</entry>
- <entry>256</entry>
- <entry>3.0.10</entry>
- </row>
- <row>
- <entry>alwaysSendSetIsolation</entry>
- <entry>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.</entry>
- <entry>true</entry>
- <entry>3.1.7</entry>
- </row>
- <row>
- <entry>maintainTimeStats</entry>
- <entry>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.</entry>
- <entry>true</entry>
- <entry>3.1.9</entry>
- </row>
- <row>
- <entry>useCursorFetch</entry>
- <entry>If connected to MySQL > 5.0.2, and setFetchSize() > 0 on a
- statement, should that statement use cursor-based
- fetching to retrieve rows?</entry>
- <entry>false</entry>
- <entry>5.0.0</entry>
- </row>
- <row>
- <entry>blobSendChunkSize</entry>
- <entry>Chunk to use when sending BLOB/CLOBs via ServerPreparedStatements</entry>
- <entry>1048576</entry>
- <entry>3.1.9</entry>
- </row>
- <row>
- <entry>cacheCallableStmts</entry>
- <entry>Should the driver cache the parsing stage of CallableStatements</entry>
- <entry>false</entry>
- <entry>3.1.2</entry>
- </row>
- <row>
- <entry>cachePrepStmts</entry>
- <entry>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?</entry>
- <entry>false</entry>
- <entry>3.0.10</entry>
- </row>
- <row>
- <entry>cacheResultSetMetadata</entry>
- <entry>Should the driver cache ResultSetMetaData for Statements and
- PreparedStatements? (Req. JDK-1.4+, true/false,
- default 'false')</entry>
- <entry>false</entry>
- <entry>3.1.1</entry>
- </row>
- <row>
- <entry>cacheServerConfiguration</entry>
- <entry>Should the driver cache the results of 'SHOW VARIABLES' and 'SHOW
- COLLATION' on a per-URL basis?</entry>
- <entry>false</entry>
- <entry>3.1.5</entry>
- </row>
- <row>
- <entry>defaultFetchSize</entry>
- <entry>The driver will call setFetchSize(n) with this value on all
- newly-created Statements</entry>
- <entry>0</entry>
- <entry>3.1.9</entry>
- </row>
- <row>
- <entry>dontTrackOpenResources</entry>
- <entry>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.</entry>
- <entry>false</entry>
- <entry>3.1.7</entry>
- </row>
- <row>
- <entry>dynamicCalendars</entry>
- <entry>Should the driver retrieve the default calendar when required, or cache
- it per connection/session?</entry>
- <entry>false</entry>
- <entry>3.1.5</entry>
- </row>
- <row>
- <entry>elideSetAutoCommits</entry>
- <entry>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)?</entry>
- <entry>false</entry>
- <entry>3.1.3</entry>
- </row>
- <row>
- <entry>enableQueryTimeouts</entry>
- <entry>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.</entry>
- <entry>true</entry>
- <entry>5.0.6</entry>
- </row>
- <row>
- <entry>holdResultsOpenOverStatementClose</entry>
- <entry>Should the driver leave the result sets open on Statement.close()
- (enabling violates JDBC specification)</entry>
- <entry>false</entry>
- <entry>3.1.7</entry>
- </row>
- <row>
- <entry>largeRowSizeThreshold</entry>
- <entry>What size result set row should the JDBC driver consider "large", and
- thus use a more memory-efficient way of representing
- the row internally?</entry>
- <entry>2048</entry>
- <entry>5.1.1</entry>
- </row>
- <row>
- <entry>loadBalanceStrategy</entry>
- <entry>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.</entry>
- <entry>random</entry>
- <entry>5.0.6</entry>
- </row>
- <row>
- <entry>locatorFetchBufferSize</entry>
- <entry>If 'emulateLocators' is configured to 'true', what size buffer should be
- used when fetching BLOB data for getBinaryInputStream?</entry>
- <entry>1048576</entry>
- <entry>3.2.1</entry>
- </row>
- <row>
- <entry>rewriteBatchedStatements</entry>
- <entry>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.</entry>
- <entry>false</entry>
- <entry>3.1.13</entry>
- </row>
- <row>
- <entry>useDirectRowUnpack</entry>
- <entry>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.</entry>
- <entry>true</entry>
- <entry>5.1.1</entry>
- </row>
- <row>
- <entry>useDynamicCharsetInfo</entry>
- <entry>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?</entry>
- <entry>true</entry>
- <entry>5.0.6</entry>
- </row>
- <row>
- <entry>useFastDateParsing</entry>
- <entry>Use internal String->Date/Time/Timestamp conversion routines to avoid
- excessive object creation?</entry>
- <entry>true</entry>
- <entry>5.0.5</entry>
- </row>
- <row>
- <entry>useFastIntParsing</entry>
- <entry>Use internal String->Integer conversion routines to avoid excessive
- object creation?</entry>
- <entry>true</entry>
- <entry>3.1.4</entry>
- </row>
- <row>
- <entry>useJvmCharsetConverters</entry>
- <entry>Always use the character encoding routines built into the JVM, rather
- than using lookup tables for single-byte character
- sets?</entry>
- <entry>false</entry>
- <entry>5.0.1</entry>
- </row>
- <row>
- <entry>useReadAheadInput</entry>
- <entry>Use newer, optimized non-blocking, buffered input stream when reading
- from the server?</entry>
- <entry>true</entry>
- <entry>3.1.5</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <title>Debugging/Profiling</title>
- </formalpara>
+ <para>
+ <informaltable>
+ <tgroup cols="4">
+ <colspec colwidth="30*" colname="cj_propstbl_prop_name"/>
+ <colspec colwidth="50*" colname="cj_propstbl_prop_defn"/>
+ <colspec colwidth="10*" colname="cj_propstbl_default"/>
+ <colspec colwidth="10*" colname="cj_propstbl_since_version"/>
+ <tbody>
+ <row>
+ <entry><emphasis role="bold"> Property Name </emphasis></entry>
+ <entry><emphasis role="bold"> Definition </emphasis></entry>
+ <entry><emphasis role="bold"> Default Value </emphasis></entry>
+ <entry><emphasis role="bold"> Since Version </emphasis></entry>
+ </row>
+ <row>
+ <entry>logger</entry>
+ <entry>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)</entry>
+ <entry>com.mysql.jdbc.log.StandardLogger</entry>
+ <entry>3.1.1</entry>
+ </row>
+ <row>
+ <entry>gatherPerfMetrics</entry>
+ <entry>Should the driver gather performance metrics, and report them via the
+ configured logger every 'reportMetricsIntervalMillis'
+ milliseconds?</entry>
+ <entry>false</entry>
+ <entry>3.1.2</entry>
+ </row>
+ <row>
+ <entry>profileSQL</entry>
+ <entry>Trace queries and their execution/fetch times to the configured logger
+ (true/false) defaults to 'false'</entry>
+ <entry>false</entry>
+ <entry>3.1.0</entry>
+ </row>
+ <row>
+ <entry>profileSql</entry>
+ <entry>Deprecated, use 'profileSQL' instead. Trace queries and their
+ execution/fetch times on STDERR (true/false) defaults to
+ 'false'</entry>
+ <entry/>
+ <entry>2.0.14</entry>
+ </row>
+ <row>
+ <entry>reportMetricsIntervalMillis</entry>
+ <entry>If 'gatherPerfMetrics' is enabled, how often should they be logged (in
+ ms)?</entry>
+ <entry>30000</entry>
+ <entry>3.1.2</entry>
+ </row>
+ <row>
+ <entry>maxQuerySizeToLog</entry>
+ <entry>Controls the maximum length/size of a query that will get logged when
+ profiling or tracing</entry>
+ <entry>2048</entry>
+ <entry>3.1.3</entry>
+ </row>
+ <row>
+ <entry>packetDebugBufferSize</entry>
+ <entry>The maximum number of packets to retain when 'enablePacketDebug' is true</entry>
+ <entry>20</entry>
+ <entry>3.1.3</entry>
+ </row>
+ <row>
+ <entry>slowQueryThresholdMillis</entry>
+ <entry>If 'logSlowQueries' is enabled, how long should a query (in ms) before
+ it is logged as 'slow'?</entry>
+ <entry>2000</entry>
+ <entry>3.1.2</entry>
+ </row>
+ <row>
+ <entry>slowQueryThresholdNanos</entry>
+ <entry>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.</entry>
+ <entry>0</entry>
+ <entry>5.0.7</entry>
+ </row>
+ <row>
+ <entry>useUsageAdvisor</entry>
+ <entry>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')?</entry>
+ <entry>false</entry>
+ <entry>3.1.1</entry>
+ </row>
+ <row>
+ <entry>autoGenerateTestcaseScript</entry>
+ <entry>Should the driver dump the SQL it is executing, including server-side
+ prepared statements to STDERR?</entry>
+ <entry>false</entry>
+ <entry>3.1.9</entry>
+ </row>
+ <row>
+ <entry>autoSlowLog</entry>
+ <entry>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?</entry>
+ <entry>true</entry>
+ <entry>5.1.4</entry>
+ </row>
+ <row>
+ <entry>clientInfoProvider</entry>
+ <entry>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</entry>
+ <entry>com.mysql.jdbc.JDBC4CommentClientInfoProvider</entry>
+ <entry>5.1.0</entry>
+ </row>
+ <row>
+ <entry>dumpMetadataOnColumnNotFound</entry>
+ <entry>Should the driver dump the field-level metadata of a result set into the
+ exception message when ResultSet.findColumn() fails?</entry>
+ <entry>false</entry>
+ <entry>3.1.13</entry>
+ </row>
+ <row>
+ <entry>dumpQueriesOnException</entry>
+ <entry>Should the driver dump the contents of the query sent to the server in
+ the message for SQLExceptions?</entry>
+ <entry>false</entry>
+ <entry>3.1.3</entry>
+ </row>
+ <row>
+ <entry>enablePacketDebug</entry>
+ <entry>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</entry>
+ <entry>false</entry>
+ <entry>3.1.3</entry>
+ </row>
+ <row>
+ <entry>explainSlowQueries</entry>
+ <entry>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?</entry>
+ <entry>false</entry>
+ <entry>3.1.2</entry>
+ </row>
+ <row>
+ <entry>includeInnodbStatusInDeadlockExceptions</entry>
+ <entry>Include the output of "SHOW ENGINE INNODB STATUS" in exception messages
+ when deadlock exceptions are detected?</entry>
+ <entry>false</entry>
+ <entry>5.0.7</entry>
+ </row>
+ <row>
+ <entry>logSlowQueries</entry>
+ <entry>Should queries that take longer than 'slowQueryThresholdMillis' be
+ logged?</entry>
+ <entry>false</entry>
+ <entry>3.1.2</entry>
+ </row>
+ <row>
+ <entry>logXaCommands</entry>
+ <entry>Should the driver log XA commands sent by MysqlXaConnection to the
+ server, at the DEBUG level of logging?</entry>
+ <entry>false</entry>
+ <entry>5.0.5</entry>
+ </row>
+ <row>
+ <entry>profilerEventHandler</entry>
+ <entry>Name of a class that implements the interface
+ com.mysql.jdbc.profiler.ProfilerEventHandler that will
+ be used to handle profiling/tracing events.</entry>
+ <entry>com.mysql.jdbc.profiler.LoggingProfilerEventHandler</entry>
+ <entry>5.1.6</entry>
+ </row>
+ <row>
+ <entry>resultSetSizeThreshold</entry>
+ <entry>If the usage advisor is enabled, how many rows should a result set
+ contain before the driver warns that it is suspiciously
+ large?</entry>
+ <entry>100</entry>
+ <entry>5.0.5</entry>
+ </row>
+ <row>
+ <entry>traceProtocol</entry>
+ <entry>Should trace-level network protocol be logged?</entry>
+ <entry>false</entry>
+ <entry>3.1.2</entry>
+ </row>
+ <row>
+ <entry>useNanosForElapsedTime</entry>
+ <entry>For profiling/debugging functionality that measures elapsed time, should
+ the driver try to use nanoseconds resolution if
+ available (JDK >= 1.5)?</entry>
+ <entry>false</entry>
+ <entry>5.0.7</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
- <formalpara>
+ </formalpara>
- <title>Debugging/Profiling</title>
+ <formalpara>
- <para>
- <informaltable>
- <tgroup cols="4">
- <colspec colwidth="30*" colname="cj_propstbl_prop_name"/>
- <colspec colwidth="50*" colname="cj_propstbl_prop_defn"/>
- <colspec colwidth="10*" colname="cj_propstbl_default"/>
- <colspec colwidth="10*" colname="cj_propstbl_since_version"/>
- <tbody>
- <row>
- <entry><emphasis role="bold"> Property Name </emphasis></entry>
- <entry><emphasis role="bold"> Definition </emphasis></entry>
- <entry><emphasis role="bold"> Default Value </emphasis></entry>
- <entry><emphasis role="bold"> Since Version </emphasis></entry>
- </row>
- <row>
- <entry>logger</entry>
- <entry>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)</entry>
- <entry>com.mysql.jdbc.log.StandardLogger</entry>
- <entry>3.1.1</entry>
- </row>
- <row>
- <entry>gatherPerfMetrics</entry>
- <entry>Should the driver gather performance metrics, and report them via the
- configured logger every 'reportMetricsIntervalMillis'
- milliseconds?</entry>
- <entry>false</entry>
- <entry>3.1.2</entry>
- </row>
- <row>
- <entry>profileSQL</entry>
- <entry>Trace queries and their execution/fetch times to the configured logger
- (true/false) defaults to 'false'</entry>
- <entry>false</entry>
- <entry>3.1.0</entry>
- </row>
- <row>
- <entry>profileSql</entry>
- <entry>Deprecated, use 'profileSQL' instead. Trace queries and their
- execution/fetch times on STDERR (true/false) defaults
- to 'false'</entry>
- <entry/>
- <entry>2.0.14</entry>
- </row>
- <row>
- <entry>reportMetricsIntervalMillis</entry>
- <entry>If 'gatherPerfMetrics' is enabled, how often should they be logged (in
- ms)?</entry>
- <entry>30000</entry>
- <entry>3.1.2</entry>
- </row>
- <row>
- <entry>maxQuerySizeToLog</entry>
- <entry>Controls the maximum length/size of a query that will get logged when
- profiling or tracing</entry>
- <entry>2048</entry>
- <entry>3.1.3</entry>
- </row>
- <row>
- <entry>packetDebugBufferSize</entry>
- <entry>The maximum number of packets to retain when 'enablePacketDebug' is true</entry>
- <entry>20</entry>
- <entry>3.1.3</entry>
- </row>
- <row>
- <entry>slowQueryThresholdMillis</entry>
- <entry>If 'logSlowQueries' is enabled, how long should a query (in ms) before
- it is logged as 'slow'?</entry>
- <entry>2000</entry>
- <entry>3.1.2</entry>
- </row>
- <row>
- <entry>slowQueryThresholdNanos</entry>
- <entry>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.</entry>
- <entry>0</entry>
- <entry>5.0.7</entry>
- </row>
- <row>
- <entry>useUsageAdvisor</entry>
- <entry>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')?</entry>
- <entry>false</entry>
- <entry>3.1.1</entry>
- </row>
- <row>
- <entry>autoGenerateTestcaseScript</entry>
- <entry>Should the driver dump the SQL it is executing, including server-side
- prepared statements to STDERR?</entry>
- <entry>false</entry>
- <entry>3.1.9</entry>
- </row>
- <row>
- <entry>autoSlowLog</entry>
- <entry>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?</entry>
- <entry>true</entry>
- <entry>5.1.4</entry>
- </row>
- <row>
- <entry>clientInfoProvider</entry>
- <entry>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</entry>
- <entry>com.mysql.jdbc.JDBC4CommentClientInfoProvider</entry>
- <entry>5.1.0</entry>
- </row>
- <row>
- <entry>dumpMetadataOnColumnNotFound</entry>
- <entry>Should the driver dump the field-level metadata of a result set into the
- exception message when ResultSet.findColumn() fails?</entry>
- <entry>false</entry>
- <entry>3.1.13</entry>
- </row>
- <row>
- <entry>dumpQueriesOnException</entry>
- <entry>Should the driver dump the contents of the query sent to the server in
- the message for SQLExceptions?</entry>
- <entry>false</entry>
- <entry>3.1.3</entry>
- </row>
- <row>
- <entry>enablePacketDebug</entry>
- <entry>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</entry>
- <entry>false</entry>
- <entry>3.1.3</entry>
- </row>
- <row>
- <entry>explainSlowQueries</entry>
- <entry>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?</entry>
- <entry>false</entry>
- <entry>3.1.2</entry>
- </row>
- <row>
- <entry>includeInnodbStatusInDeadlockExceptions</entry>
- <entry>Include the output of "SHOW ENGINE INNODB STATUS" in exception messages
- when deadlock exceptions are detected?</entry>
- <entry>false</entry>
- <entry>5.0.7</entry>
- </row>
- <row>
- <entry>logSlowQueries</entry>
- <entry>Should queries that take longer than 'slowQueryThresholdMillis' be
- logged?</entry>
- <entry>false</entry>
- <entry>3.1.2</entry>
- </row>
- <row>
- <entry>logXaCommands</entry>
- <entry>Should the driver log XA commands sent by MysqlXaConnection to the
- server, at the DEBUG level of logging?</entry>
- <entry>false</entry>
- <entry>5.0.5</entry>
- </row>
- <row>
- <entry>profilerEventHandler</entry>
- <entry>Name of a class that implements the interface
- com.mysql.jdbc.profiler.ProfilerEventHandler that will
- be used to handle profiling/tracing events.</entry>
- <entry>com.mysql.jdbc.profiler.LoggingProfilerEventHandler</entry>
- <entry>5.1.6</entry>
- </row>
- <row>
- <entry>resultSetSizeThreshold</entry>
- <entry>If the usage advisor is enabled, how many rows should a result set
- contain before the driver warns that it is
- suspiciously large?</entry>
- <entry>100</entry>
- <entry>5.0.5</entry>
- </row>
- <row>
- <entry>traceProtocol</entry>
- <entry>Should trace-level network protocol be logged?</entry>
- <entry>false</entry>
- <entry>3.1.2</entry>
- </row>
- <row>
- <entry>useNanosForElapsedTime</entry>
- <entry>For profiling/debugging functionality that measures elapsed time, should
- the driver try to use nanoseconds resolution if
- available (JDK >= 1.5)?</entry>
- <entry>false</entry>
- <entry>5.0.7</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <title>Miscellaneous</title>
- </formalpara>
+ <para>
+ <informaltable>
+ <tgroup cols="4">
+ <colspec colwidth="30*" colname="cj_propstbl_prop_name"/>
+ <colspec colwidth="50*" colname="cj_propstbl_prop_defn"/>
+ <colspec colwidth="10*" colname="cj_propstbl_default"/>
+ <colspec colwidth="10*" colname="cj_propstbl_since_version"/>
+ <tbody>
+ <row>
+ <entry><emphasis role="bold"> Property Name </emphasis></entry>
+ <entry><emphasis role="bold"> Definition </emphasis></entry>
+ <entry><emphasis role="bold"> Default Value </emphasis></entry>
+ <entry><emphasis role="bold"> Since Version </emphasis></entry>
+ </row>
+ <row>
+ <entry>useUnicode</entry>
+ <entry>Forces the driver to use Unicode character encodings. Should only be set
+ to false either when the driver can't determine the
+ character set mapping (in which case, specify the Java
+ character encoding in the characterEncoding property),
+ or you are trying to force the driver to use a character
+ set that MySQL doesn't natively support. Should be
+ 'true' for all versions of MySQL 4.1 or higher unless
+ you are trying to emulate the character set handling
+ support provided in MySQL 4.0. Value is true/false,
+ defaults to 'true'</entry>
+ <entry>true</entry>
+ <entry>1.1g</entry>
+ </row>
+ <row>
+ <entry>characterEncoding</entry>
+ <entry>If 'useUnicode' is set to true, what Java character encoding should the
+ driver use when dealing with strings? (defaults is to
+ 'autodetect'). If the encoding cannot be determined,
+ then an exception will be raised.</entry>
+ <entry/>
+ <entry>1.1g</entry>
+ </row>
+ <row>
+ <entry>characterSetResults</entry>
+ <entry>Character set to tell the server to return results as.</entry>
+ <entry/>
+ <entry>3.0.13</entry>
+ </row>
+ <row>
+ <entry>connectionCollation</entry>
+ <entry>If set, tells the server to use this collation via 'set
+ collation_connection'</entry>
+ <entry/>
+ <entry>3.0.13</entry>
+ </row>
+ <row>
+ <entry>useBlobToStoreUTF8OutsideBMP</entry>
+ <entry>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.</entry>
+ <entry>false</entry>
+ <entry>5.1.3</entry>
+ </row>
+ <row>
+ <entry>utf8OutsideBmpExcludedColumnNamePattern</entry>
+ <entry>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.</entry>
+ <entry/>
+ <entry>5.1.3</entry>
+ </row>
+ <row>
+ <entry>utf8OutsideBmpIncludedColumnNamePattern</entry>
+ <entry>Used to specify exclusion rules to
+ "utf8OutsideBmpExcludedColumnNamePattern". The regex
+ must follow the patterns used for the java.util.regex
+ package.</entry>
+ <entry/>
+ <entry>5.1.3</entry>
+ </row>
+ <row>
+ <entry>loadBalanceEnableJMX</entry>
+ <entry>Enables JMX-based management of load-balanced connection groups,
+ including live addition/removal of hosts from
+ load-balancing pool.</entry>
+ <entry>false</entry>
+ <entry>5.1.13</entry>
+ </row>
+ <row>
+ <entry>sessionVariables</entry>
+ <entry>A comma-separated list of name/value pairs to be sent as SET SESSION ...
+ to the server when the driver connects.</entry>
+ <entry/>
+ <entry>3.1.8</entry>
+ </row>
+ <row>
+ <entry>useColumnNamesInFindColumn</entry>
+ <entry>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.</entry>
+ <entry>false</entry>
+ <entry>5.1.7</entry>
+ </row>
+ <row>
+ <entry>allowNanAndInf</entry>
+ <entry>Should the driver allow NaN or +/- INF values in
+ PreparedStatement.setDouble()?</entry>
+ <entry>false</entry>
+ <entry>3.1.5</entry>
+ </row>
+ <row>
+ <entry>autoClosePStmtStreams</entry>
+ <entry>Should the driver automatically call .close() on streams/readers passed
+ as arguments via set*() methods?</entry>
+ <entry>false</entry>
+ <entry>3.1.12</entry>
+ </row>
+ <row>
+ <entry>autoDeserialize</entry>
+ <entry>Should the driver automatically detect and de-serialize objects stored
+ in BLOB fields?</entry>
+ <entry>false</entry>
+ <entry>3.1.5</entry>
+ </row>
+ <row>
+ <entry>blobsAreStrings</entry>
+ <entry>Should the driver always treat BLOBs as Strings - specifically to work
+ around dubious metadata returned by the server for GROUP
+ BY clauses?</entry>
+ <entry>false</entry>
+ <entry>5.0.8</entry>
+ </row>
+ <row>
+ <entry>capitalizeTypeNames</entry>
+ <entry>Capitalize type names in DatabaseMetaData? (usually only useful when
+ using WebObjects, true/false, defaults to 'false')</entry>
+ <entry>true</entry>
+ <entry>2.0.7</entry>
+ </row>
+ <row>
+ <entry>clobCharacterEncoding</entry>
+ <entry>The character encoding to use for sending and retrieving TEXT,
+ MEDIUMTEXT and LONGTEXT values instead of the configured
+ connection characterEncoding</entry>
+ <entry/>
+ <entry>5.0.0</entry>
+ </row>
+ <row>
+ <entry>clobberStreamingResults</entry>
+ <entry>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.</entry>
+ <entry>false</entry>
+ <entry>3.0.9</entry>
+ </row>
+ <row>
+ <entry>compensateOnDuplicateKeyUpdateCounts</entry>
+ <entry>Should the driver compensate for the update counts of "ON DUPLICATE KEY"
+ INSERT statements (2 = 1, 0 = 1) when using prepared
+ statements?</entry>
+ <entry>false</entry>
+ <entry>5.1.7</entry>
+ </row>
+ <row>
+ <entry>continueBatchOnError</entry>
+ <entry>Should the driver continue processing batch commands if one statement
+ fails. The JDBC spec allows either way (defaults to
+ 'true').</entry>
+ <entry>true</entry>
+ <entry>3.0.3</entry>
+ </row>
+ <row>
+ <entry>createDatabaseIfNotExist</entry>
+ <entry>Creates the database given in the URL if it doesn't yet exist. Assumes
+ the configured user has permissions to create databases.</entry>
+ <entry>false</entry>
+ <entry>3.1.9</entry>
+ </row>
+ <row>
+ <entry>emptyStringsConvertToZero</entry>
+ <entry>Should the driver allow conversions from empty string fields to numeric
+ values of '0'?</entry>
+ <entry>true</entry>
+ <entry>3.1.8</entry>
+ </row>
+ <row>
+ <entry>emulateLocators</entry>
+ <entry>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.</entry>
+ <entry>false</entry>
+ <entry>3.1.0</entry>
+ </row>
+ <row>
+ <entry>emulateUnsupportedPstmts</entry>
+ <entry>Should the driver detect prepared statements that are not supported by
+ the server, and replace them with client-side emulated
+ versions?</entry>
+ <entry>true</entry>
+ <entry>3.1.7</entry>
+ </row>
+ <row>
+ <entry>exceptionInterceptors</entry>
+ <entry>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.</entry>
+ <entry/>
+ <entry>5.1.8</entry>
+ </row>
+ <row>
+ <entry>functionsNeverReturnBlobs</entry>
+ <entry>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?</entry>
+ <entry>false</entry>
+ <entry>5.0.8</entry>
+ </row>
+ <row>
+ <entry>generateSimpleParameterMetadata</entry>
+ <entry>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?</entry>
+ <entry>false</entry>
+ <entry>5.0.5</entry>
+ </row>
+ <row>
+ <entry>ignoreNonTxTables</entry>
+ <entry>Ignore non-transactional table warning for rollback? (defaults to
+ 'false').</entry>
+ <entry>false</entry>
+ <entry>3.0.9</entry>
+ </row>
+ <row>
+ <entry>jdbcCompliantTruncation</entry>
+ <entry>This sets whether Connector/J should throw java.sql.DataTruncation
+ exceptions when data is truncated. This 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. Note that if STRICT_TRANS_TABLES is
+ not set, it will be set as a result of using this
+ connection string option.</entry>
+ <entry>true</entry>
+ <entry>3.1.2</entry>
+ </row>
+ <row>
+ <entry>loadBalanceBlacklistTimeout</entry>
+ <entry>Time in milliseconds between checks of servers which are unavailable.</entry>
+ <entry>0</entry>
+ <entry>5.1.0</entry>
+ </row>
+ <row>
+ <entry>loadBalanceConnectionGroup</entry>
+ <entry>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.</entry>
+ <entry/>
+ <entry>5.1.13</entry>
+ </row>
+ <row>
+ <entry>loadBalanceExceptionChecker</entry>
+ <entry>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.</entry>
+ <entry>com.mysql.jdbc.StandardLoadBalanceExceptionChecker</entry>
+ <entry>5.1.13</entry>
+ </row>
+ <row>
+ <entry>loadBalancePingTimeout</entry>
+ <entry>Time in milliseconds to wait for ping response from each of
+ load-balanced physical connections when using
+ load-balanced Connection.</entry>
+ <entry>0</entry>
+ <entry>5.1.13</entry>
+ </row>
+ <row>
+ <entry>loadBalanceSQLExceptionSubclassFailover</entry>
+ <entry>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.</entry>
+ <entry/>
+ <entry>5.1.13</entry>
+ </row>
+ <row>
+ <entry>loadBalanceSQLStateFailover</entry>
+ <entry>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.</entry>
+ <entry/>
+ <entry>5.1.13</entry>
+ </row>
+ <row>
+ <entry>loadBalanceValidateConnectionOnSwapServer</entry>
+ <entry>Should the load-balanced Connection explicitly check whether the
+ connection is live when swapping to a new physical
+ connection at commit/rollback?</entry>
+ <entry>false</entry>
+ <entry>5.1.13</entry>
+ </row>
+ <row>
+ <entry>maxRows</entry>
+ <entry>The maximum number of rows to return (0, the default means return all
+ rows).</entry>
+ <entry>-1</entry>
+ <entry>all versions</entry>
+ </row>
+ <row>
+ <entry>netTimeoutForStreamingResults</entry>
+ <entry>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)</entry>
+ <entry>600</entry>
+ <entry>5.1.0</entry>
+ </row>
+ <row>
+ <entry>noAccessToProcedureBodies</entry>
+ <entry>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?</entry>
+ <entry>false</entry>
+ <entry>5.0.3</entry>
+ </row>
+ <row>
+ <entry>noDatetimeStringSync</entry>
+ <entry>Don't ensure that
+ ResultSet.getDatetimeType().toString().equals(ResultSet.getString())</entry>
+ <entry>false</entry>
+ <entry>3.1.7</entry>
+ </row>
+ <row>
+ <entry>noTimezoneConversionForTimeType</entry>
+ <entry>Don't convert TIME values using the server timezone if
+ 'useTimezone'='true'</entry>
+ <entry>false</entry>
+ <entry>5.0.0</entry>
+ </row>
+ <row>
+ <entry>nullCatalogMeansCurrent</entry>
+ <entry>When DatabaseMetadataMethods ask for a 'catalog' parameter, does the
+ value null mean use the current catalog? When
+ nullCatalogMeansCurrent is true the current catalog will
+ be used if the catalog parameter is null. If
+ nullCatalogMeansCurrent is false and the catalog
+ parameter is null then the catalog parameter is not used
+ to restrict the catalog search. (This is not
+ JDBC-compliant, but follows legacy behavior from earlier
+ versions of the driver)</entry>
+ <entry>true</entry>
+ <entry>3.1.8</entry>
+ </row>
+ <row>
+ <entry>nullNamePatternMatchesAll</entry>
+ <entry>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)</entry>
+ <entry>true</entry>
+ <entry>3.1.8</entry>
+ </row>
+ <row>
+ <entry>overrideSupportsIntegrityEnhancementFacility</entry>
+ <entry>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)?</entry>
+ <entry>false</entry>
+ <entry>3.1.12</entry>
+ </row>
+ <row>
+ <entry>padCharsWithSpace</entry>
+ <entry>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)?</entry>
+ <entry>false</entry>
+ <entry>5.0.6</entry>
+ </row>
+ <row>
+ <entry>pedantic</entry>
+ <entry>Follow the JDBC spec to the letter.</entry>
+ <entry>false</entry>
+ <entry>3.0.0</entry>
+ </row>
+ <row>
+ <entry>pinGlobalTxToPhysicalConnection</entry>
+ <entry>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</entry>
+ <entry>false</entry>
+ <entry>5.0.1</entry>
+ </row>
+ <row>
+ <entry>populateInsertRowWithDefaultValues</entry>
+ <entry>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.</entry>
+ <entry>false</entry>
+ <entry>5.0.5</entry>
+ </row>
+ <row>
+ <entry>processEscapeCodesForPrepStmts</entry>
+ <entry>Should the driver process escape codes in queries that are prepared?</entry>
+ <entry>true</entry>
+ <entry>3.1.12</entry>
+ </row>
+ <row>
+ <entry>queryTimeoutKillsConnection</entry>
+ <entry>If the timeout given in Statement.setQueryTimeout() expires, should the
+ driver forcibly abort the Connection instead of
+ attempting to abort the query?</entry>
+ <entry>false</entry>
+ <entry>5.1.9</entry>
+ </row>
+ <row>
+ <entry>relaxAutoCommit</entry>
+ <entry>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')?</entry>
+ <entry>false</entry>
+ <entry>2.0.13</entry>
+ </row>
+ <row>
+ <entry>retainStatementAfterResultSetClose</entry>
+ <entry>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.</entry>
+ <entry>false</entry>
+ <entry>3.1.11</entry>
+ </row>
+ <row>
+ <entry>rollbackOnPooledClose</entry>
+ <entry>Should the driver issue a rollback() when the logical connection in a
+ pool is closed?</entry>
+ <entry>true</entry>
+ <entry>3.0.15</entry>
+ </row>
+ <row>
+ <entry>runningCTS13</entry>
+ <entry>Enables workarounds for bugs in Sun's JDBC compliance testsuite version
+ 1.3</entry>
+ <entry>false</entry>
+ <entry>3.1.7</entry>
+ </row>
+ <row>
+ <entry>serverTimezone</entry>
+ <entry>Override detection/mapping of timezone. Used when timezone from server
+ doesn't map to Java timezone</entry>
+ <entry/>
+ <entry>3.0.2</entry>
+ </row>
+ <row>
+ <entry>statementInterceptors</entry>
+ <entry>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.</entry>
+ <entry/>
+ <entry>5.1.1</entry>
+ </row>
+ <row>
+ <entry>strictFloatingPoint</entry>
+ <entry>Used only in older versions of compliance test</entry>
+ <entry>false</entry>
+ <entry>3.0.0</entry>
+ </row>
+ <row>
+ <entry>strictUpdates</entry>
+ <entry>Should the driver do strict checking (all primary keys selected) of
+ updatable result sets (true, false, defaults to 'true')?</entry>
+ <entry>true</entry>
+ <entry>3.0.4</entry>
+ </row>
+ <row>
+ <entry>tinyInt1isBit</entry>
+ <entry>Should the driver treat the datatype TINYINT(1) as the BIT type (because
+ the server silently converts BIT -> TINYINT(1) when
+ creating tables)?</entry>
+ <entry>true</entry>
+ <entry>3.0.16</entry>
+ </row>
+ <row>
+ <entry>transformedBitIsBoolean</entry>
+ <entry>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?</entry>
+ <entry>false</entry>
+ <entry>3.1.9</entry>
+ </row>
+ <row>
+ <entry>treatUtilDateAsTimestamp</entry>
+ <entry>Should the driver treat java.util.Date as a TIMESTAMP for the purposes
+ of PreparedStatement.setObject()?</entry>
+ <entry>true</entry>
+ <entry>5.0.5</entry>
+ </row>
+ <row>
+ <entry>ultraDevHack</entry>
+ <entry>Create PreparedStatements for prepareCall() when required, because
+ UltraDev is broken and issues a prepareCall() for _all_
+ statements? (true/false, defaults to 'false')</entry>
+ <entry>false</entry>
+ <entry>2.0.3</entry>
+ </row>
+ <row>
+ <entry>useAffectedRows</entry>
+ <entry>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.</entry>
+ <entry>false</entry>
+ <entry>5.1.7</entry>
+ </row>
+ <row>
+ <entry>useGmtMillisForDatetimes</entry>
+ <entry>Convert between session timezone and GMT before creating Date and
+ Timestamp instances (value of "false" is legacy
+ behavior, "true" leads to more JDBC-compliant behavior.</entry>
+ <entry>false</entry>
+ <entry>3.1.12</entry>
+ </row>
+ <row>
+ <entry>useHostsInPrivileges</entry>
+ <entry>Add '@hostname' to users in DatabaseMetaData.getColumn/TablePrivileges()
+ (true/false), defaults to 'true'.</entry>
+ <entry>true</entry>
+ <entry>3.0.2</entry>
+ </row>
+ <row>
+ <entry>useInformationSchema</entry>
+ <entry>When connected to MySQL-5.0.7 or newer, should the driver use the
+ INFORMATION_SCHEMA to derive information used by
+ DatabaseMetaData?</entry>
+ <entry>false</entry>
+ <entry>5.0.0</entry>
+ </row>
+ <row>
+ <entry>useJDBCCompliantTimezoneShift</entry>
+ <entry>Should the driver use JDBC-compliant rules when converting
+ TIME/TIMESTAMP/DATETIME values' timezone information for
+ those JDBC arguments which take a java.util.Calendar
+ argument? (Notice that this option is exclusive of the
+ "useTimezone=true" configuration option.)</entry>
+ <entry>false</entry>
+ <entry>5.0.0</entry>
+ </row>
+ <row>
+ <entry>useLegacyDatetimeCode</entry>
+ <entry>Use code for DATE/TIME/DATETIME/TIMESTAMP handling in result sets and
+ statements that consistently handles timezone
+ 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?</entry>
+ <entry>true</entry>
+ <entry>5.1.6</entry>
+ </row>
+ <row>
+ <entry>useOldAliasMetadataBehavior</entry>
+ <entry>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.</entry>
+ <entry>false</entry>
+ <entry>5.0.4</entry>
+ </row>
+ <row>
+ <entry>useOldUTF8Behavior</entry>
+ <entry>Use the UTF-8 behavior the driver did when communicating with 4.0 and
+ older servers</entry>
+ <entry>false</entry>
+ <entry>3.1.6</entry>
+ </row>
+ <row>
+ <entry>useOnlyServerErrorMessages</entry>
+ <entry>Don't prepend 'standard' SQLState error messages to error messages
+ returned by the server.</entry>
+ <entry>true</entry>
+ <entry>3.0.15</entry>
+ </row>
+ <row>
+ <entry>useSSPSCompatibleTimezoneShift</entry>
+ <entry>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.</entry>
+ <entry>false</entry>
+ <entry>5.0.5</entry>
+ </row>
+ <row>
+ <entry>useServerPrepStmts</entry>
+ <entry>Use server-side prepared statements if the server supports them?</entry>
+ <entry>false</entry>
+ <entry>3.1.0</entry>
+ </row>
+ <row>
+ <entry>useSqlStateCodes</entry>
+ <entry>Use SQL Standard state codes instead of 'legacy' X/Open/SQL state codes
+ (true/false), default is 'true'</entry>
+ <entry>true</entry>
+ <entry>3.1.3</entry>
+ </row>
+ <row>
+ <entry>useStreamLengthsInPrepStmts</entry>
+ <entry>Honor stream length parameter in
+ PreparedStatement/ResultSet.setXXXStream() method calls
+ (true/false, defaults to 'true')?</entry>
+ <entry>true</entry>
+ <entry>3.0.2</entry>
+ </row>
+ <row>
+ <entry>useTimezone</entry>
+ <entry>Convert time/date types between client and server timezones (true/false,
+ defaults to 'false')?</entry>
+ <entry>false</entry>
+ <entry>3.0.2</entry>
+ </row>
+ <row>
+ <entry>useUnbufferedInput</entry>
+ <entry>Don't use BufferedInputStream for reading data from the server</entry>
+ <entry>true</entry>
+ <entry>3.0.11</entry>
+ </row>
+ <row>
+ <entry>yearIsDateType</entry>
+ <entry>Should the JDBC driver treat the MySQL type "YEAR" as a java.sql.Date,
+ or as a SHORT?</entry>
+ <entry>true</entry>
+ <entry>3.1.9</entry>
+ </row>
+ <row>
+ <entry>zeroDateTimeBehavior</entry>
+ <entry>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".</entry>
+ <entry>exception</entry>
+ <entry>3.1.4</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
- <formalpara>
+ </formalpara>
- <title>Miscellaneous</title>
-
- <para>
- <informaltable>
- <tgroup cols="4">
- <colspec colwidth="30*" colname="cj_propstbl_prop_name"/>
- <colspec colwidth="50*" colname="cj_propstbl_prop_defn"/>
- <colspec colwidth="10*" colname="cj_propstbl_default"/>
- <colspec colwidth="10*" colname="cj_propstbl_since_version"/>
- <tbody>
- <row>
- <entry><emphasis role="bold"> Property Name </emphasis></entry>
- <entry><emphasis role="bold"> Definition </emphasis></entry>
- <entry><emphasis role="bold"> Default Value </emphasis></entry>
- <entry><emphasis role="bold"> Since Version </emphasis></entry>
- </row>
- <row>
- <entry>useUnicode</entry>
- <entry>Forces the driver to use Unicode character encodings. Should only be set
- to false either when the driver can't determine the
- character set mapping (in which case, specify the Java
- character encoding in the characterEncoding property),
- or you are trying to force the driver to use a
- character set that MySQL doesn't natively support.
- Should be 'true' for all versions of MySQL 4.1 or
- higher unless you are trying to emulate the character
- set handling support provided in MySQL 4.0. Value is
- true/false, defaults to 'true'</entry>
- <entry>true</entry>
- <entry>1.1g</entry>
- </row>
- <row>
- <entry>characterEncoding</entry>
- <entry>If 'useUnicode' is set to true, what Java character encoding should the
- driver use when dealing with strings? (defaults is to
- 'autodetect'). If the encoding cannot be determined,
- then an exception will be raised.</entry>
- <entry/>
- <entry>1.1g</entry>
- </row>
- <row>
- <entry>characterSetResults</entry>
- <entry>Character set to tell the server to return results as.</entry>
- <entry/>
- <entry>3.0.13</entry>
- </row>
- <row>
- <entry>connectionCollation</entry>
- <entry>If set, tells the server to use this collation via 'set
- collation_connection'</entry>
- <entry/>
- <entry>3.0.13</entry>
- </row>
- <row>
- <entry>useBlobToStoreUTF8OutsideBMP</entry>
- <entry>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.</entry>
- <entry>false</entry>
- <entry>5.1.3</entry>
- </row>
- <row>
- <entry>utf8OutsideBmpExcludedColumnNamePattern</entry>
- <entry>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.</entry>
- <entry/>
- <entry>5.1.3</entry>
- </row>
- <row>
- <entry>utf8OutsideBmpIncludedColumnNamePattern</entry>
- <entry>Used to specify exclusion rules to
- "utf8OutsideBmpExcludedColumnNamePattern". The regex
- must follow the patterns used for the java.util.regex
- package.</entry>
- <entry/>
- <entry>5.1.3</entry>
- </row>
- <row>
- <entry>loadBalanceEnableJMX</entry>
- <entry>Enables JMX-based management of load-balanced connection groups,
- including live addition/removal of hosts from
- load-balancing pool.</entry>
- <entry>false</entry>
- <entry>5.1.13</entry>
- </row>
- <row>
- <entry>sessionVariables</entry>
- <entry>A comma-separated list of name/value pairs to be sent as SET SESSION ...
- to the server when the driver connects.</entry>
- <entry/>
- <entry>3.1.8</entry>
- </row>
- <row>
- <entry>useColumnNamesInFindColumn</entry>
- <entry>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.</entry>
- <entry>false</entry>
- <entry>5.1.7</entry>
- </row>
- <row>
- <entry>allowNanAndInf</entry>
- <entry>Should the driver allow NaN or +/- INF values in
- PreparedStatement.setDouble()?</entry>
- <entry>false</entry>
- <entry>3.1.5</entry>
- </row>
- <row>
- <entry>autoClosePStmtStreams</entry>
- <entry>Should the driver automatically call .close() on streams/readers passed
- as arguments via set*() methods?</entry>
- <entry>false</entry>
- <entry>3.1.12</entry>
- </row>
- <row>
- <entry>autoDeserialize</entry>
- <entry>Should the driver automatically detect and de-serialize objects stored
- in BLOB fields?</entry>
- <entry>false</entry>
- <entry>3.1.5</entry>
- </row>
- <row>
- <entry>blobsAreStrings</entry>
- <entry>Should the driver always treat BLOBs as Strings - specifically to work
- around dubious metadata returned by the server for
- GROUP BY clauses?</entry>
- <entry>false</entry>
- <entry>5.0.8</entry>
- </row>
- <row>
- <entry>capitalizeTypeNames</entry>
- <entry>Capitalize type names in DatabaseMetaData? (usually only useful when
- using WebObjects, true/false, defaults to 'false')</entry>
- <entry>true</entry>
- <entry>2.0.7</entry>
- </row>
- <row>
- <entry>clobCharacterEncoding</entry>
- <entry>The character encoding to use for sending and retrieving TEXT,
- MEDIUMTEXT and LONGTEXT values instead of the
- configured connection characterEncoding</entry>
- <entry/>
- <entry>5.0.0</entry>
- </row>
- <row>
- <entry>clobberStreamingResults</entry>
- <entry>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.</entry>
- <entry>false</entry>
- <entry>3.0.9</entry>
- </row>
- <row>
- <entry>compensateOnDuplicateKeyUpdateCounts</entry>
- <entry>Should the driver compensate for the update counts of "ON DUPLICATE KEY"
- INSERT statements (2 = 1, 0 = 1) when using prepared
- statements?</entry>
- <entry>false</entry>
- <entry>5.1.7</entry>
- </row>
- <row>
- <entry>continueBatchOnError</entry>
- <entry>Should the driver continue processing batch commands if one statement
- fails. The JDBC spec allows either way (defaults to
- 'true').</entry>
- <entry>true</entry>
- <entry>3.0.3</entry>
- </row>
- <row>
- <entry>createDatabaseIfNotExist</entry>
- <entry>Creates the database given in the URL if it doesn't yet exist. Assumes
- the configured user has permissions to create
- databases.</entry>
- <entry>false</entry>
- <entry>3.1.9</entry>
- </row>
- <row>
- <entry>emptyStringsConvertToZero</entry>
- <entry>Should the driver allow conversions from empty string fields to numeric
- values of '0'?</entry>
- <entry>true</entry>
- <entry>3.1.8</entry>
- </row>
- <row>
- <entry>emulateLocators</entry>
- <entry>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.</entry>
- <entry>false</entry>
- <entry>3.1.0</entry>
- </row>
- <row>
- <entry>emulateUnsupportedPstmts</entry>
- <entry>Should the driver detect prepared statements that are not supported by
- the server, and replace them with client-side emulated
- versions?</entry>
- <entry>true</entry>
- <entry>3.1.7</entry>
- </row>
- <row>
- <entry>exceptionInterceptors</entry>
- <entry>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.</entry>
- <entry/>
- <entry>5.1.8</entry>
- </row>
- <row>
- <entry>functionsNeverReturnBlobs</entry>
- <entry>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?</entry>
- <entry>false</entry>
- <entry>5.0.8</entry>
- </row>
- <row>
- <entry>generateSimpleParameterMetadata</entry>
- <entry>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?</entry>
- <entry>false</entry>
- <entry>5.0.5</entry>
- </row>
- <row>
- <entry>ignoreNonTxTables</entry>
- <entry>Ignore non-transactional table warning for rollback? (defaults to
- 'false').</entry>
- <entry>false</entry>
- <entry>3.0.9</entry>
- </row>
- <row>
- <entry>jdbcCompliantTruncation</entry>
- <entry>This sets whether Connector/J should throw java.sql.DataTruncation
- exceptions when data is truncated. This 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. Note that if STRICT_TRANS_TABLES
- is not set, it will be set as a result of using this
- connection string option.</entry>
- <entry>true</entry>
- <entry>3.1.2</entry>
- </row>
- <row>
- <entry>loadBalanceBlacklistTimeout</entry>
- <entry>Time in milliseconds between checks of servers which are unavailable.</entry>
- <entry>0</entry>
- <entry>5.1.0</entry>
- </row>
- <row>
- <entry>loadBalanceConnectionGroup</entry>
- <entry>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.</entry>
- <entry/>
- <entry>5.1.13</entry>
- </row>
- <row>
- <entry>loadBalanceExceptionChecker</entry>
- <entry>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.</entry>
- <entry>com.mysql.jdbc.StandardLoadBalanceExceptionChecker</entry>
- <entry>5.1.13</entry>
- </row>
- <row>
- <entry>loadBalancePingTimeout</entry>
- <entry>Time in milliseconds to wait for ping response from each of
- load-balanced physical connections when using
- load-balanced Connection.</entry>
- <entry>0</entry>
- <entry>5.1.13</entry>
- </row>
- <row>
- <entry>loadBalanceSQLExceptionSubclassFailover</entry>
- <entry>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.</entry>
- <entry/>
- <entry>5.1.13</entry>
- </row>
- <row>
- <entry>loadBalanceSQLStateFailover</entry>
- <entry>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.</entry>
- <entry/>
- <entry>5.1.13</entry>
- </row>
- <row>
- <entry>loadBalanceValidateConnectionOnSwapServer</entry>
- <entry>Should the load-balanced Connection explicitly check whether the
- connection is live when swapping to a new physical
- connection at commit/rollback?</entry>
- <entry>false</entry>
- <entry>5.1.13</entry>
- </row>
- <row>
- <entry>maxRows</entry>
- <entry>The maximum number of rows to return (0, the default means return all
- rows).</entry>
- <entry>-1</entry>
- <entry>all versions</entry>
- </row>
- <row>
- <entry>netTimeoutForStreamingResults</entry>
- <entry>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)</entry>
- <entry>600</entry>
- <entry>5.1.0</entry>
- </row>
- <row>
- <entry>noAccessToProcedureBodies</entry>
- <entry>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?</entry>
- <entry>false</entry>
- <entry>5.0.3</entry>
- </row>
- <row>
- <entry>noDatetimeStringSync</entry>
- <entry>Don't ensure that
- ResultSet.getDatetimeType().toString().equals(ResultSet.getString())</entry>
- <entry>false</entry>
- <entry>3.1.7</entry>
- </row>
- <row>
- <entry>noTimezoneConversionForTimeType</entry>
- <entry>Don't convert TIME values using the server timezone if
- 'useTimezone'='true'</entry>
- <entry>false</entry>
- <entry>5.0.0</entry>
- </row>
- <row>
- <entry>nullCatalogMeansCurrent</entry>
- <entry>When DatabaseMetadataMethods ask for a 'catalog' parameter, does the
- value null mean use the current catalog? When
- nullCatalogMeansCurrent is true the current catalog
- will be used if the catalog parameter is null. If
- nullCatalogMeansCurrent is false and the catalog
- parameter is null then the catalog parameter is not
- used to restrict the catalog search. (This is not
- JDBC-compliant, but follows legacy behavior from
- earlier versions of the driver)</entry>
- <entry>true</entry>
- <entry>3.1.8</entry>
- </row>
- <row>
- <entry>nullNamePatternMatchesAll</entry>
- <entry>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)</entry>
- <entry>true</entry>
- <entry>3.1.8</entry>
- </row>
- <row>
- <entry>overrideSupportsIntegrityEnhancementFacility</entry>
- <entry>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)?</entry>
- <entry>false</entry>
- <entry>3.1.12</entry>
- </row>
- <row>
- <entry>padCharsWithSpace</entry>
- <entry>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)?</entry>
- <entry>false</entry>
- <entry>5.0.6</entry>
- </row>
- <row>
- <entry>pedantic</entry>
- <entry>Follow the JDBC spec to the letter.</entry>
- <entry>false</entry>
- <entry>3.0.0</entry>
- </row>
- <row>
- <entry>pinGlobalTxToPhysicalConnection</entry>
- <entry>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</entry>
- <entry>false</entry>
- <entry>5.0.1</entry>
- </row>
- <row>
- <entry>populateInsertRowWithDefaultValues</entry>
- <entry>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.</entry>
- <entry>false</entry>
- <entry>5.0.5</entry>
- </row>
- <row>
- <entry>processEscapeCodesForPrepStmts</entry>
- <entry>Should the driver process escape codes in queries that are prepared?</entry>
- <entry>true</entry>
- <entry>3.1.12</entry>
- </row>
- <row>
- <entry>queryTimeoutKillsConnection</entry>
- <entry>If the timeout given in Statement.setQueryTimeout() expires, should the
- driver forcibly abort the Connection instead of
- attempting to abort the query?</entry>
- <entry>false</entry>
- <entry>5.1.9</entry>
- </row>
- <row>
- <entry>relaxAutoCommit</entry>
- <entry>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')?</entry>
- <entry>false</entry>
- <entry>2.0.13</entry>
- </row>
- <row>
- <entry>retainStatementAfterResultSetClose</entry>
- <entry>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.</entry>
- <entry>false</entry>
- <entry>3.1.11</entry>
- </row>
- <row>
- <entry>rollbackOnPooledClose</entry>
- <entry>Should the driver issue a rollback() when the logical connection in a
- pool is closed?</entry>
- <entry>true</entry>
- <entry>3.0.15</entry>
- </row>
- <row>
- <entry>runningCTS13</entry>
- <entry>Enables workarounds for bugs in Sun's JDBC compliance testsuite version
- 1.3</entry>
- <entry>false</entry>
- <entry>3.1.7</entry>
- </row>
- <row>
- <entry>serverTimezone</entry>
- <entry>Override detection/mapping of timezone. Used when timezone from server
- doesn't map to Java timezone</entry>
- <entry/>
- <entry>3.0.2</entry>
- </row>
- <row>
- <entry>statementInterceptors</entry>
- <entry>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.</entry>
- <entry/>
- <entry>5.1.1</entry>
- </row>
- <row>
- <entry>strictFloatingPoint</entry>
- <entry>Used only in older versions of compliance test</entry>
- <entry>false</entry>
- <entry>3.0.0</entry>
- </row>
- <row>
- <entry>strictUpdates</entry>
- <entry>Should the driver do strict checking (all primary keys selected) of
- updatable result sets (true, false, defaults to
- 'true')?</entry>
- <entry>true</entry>
- <entry>3.0.4</entry>
- </row>
- <row>
- <entry>tinyInt1isBit</entry>
- <entry>Should the driver treat the datatype TINYINT(1) as the BIT type (because
- the server silently converts BIT -> TINYINT(1) when
- creating tables)?</entry>
- <entry>true</entry>
- <entry>3.0.16</entry>
- </row>
- <row>
- <entry>transformedBitIsBoolean</entry>
- <entry>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?</entry>
- <entry>false</entry>
- <entry>3.1.9</entry>
- </row>
- <row>
- <entry>treatUtilDateAsTimestamp</entry>
- <entry>Should the driver treat java.util.Date as a TIMESTAMP for the purposes
- of PreparedStatement.setObject()?</entry>
- <entry>true</entry>
- <entry>5.0.5</entry>
- </row>
- <row>
- <entry>ultraDevHack</entry>
- <entry>Create PreparedStatements for prepareCall() when required, because
- UltraDev is broken and issues a prepareCall() for
- _all_ statements? (true/false, defaults to 'false')</entry>
- <entry>false</entry>
- <entry>2.0.3</entry>
- </row>
- <row>
- <entry>useAffectedRows</entry>
- <entry>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.</entry>
- <entry>false</entry>
- <entry>5.1.7</entry>
- </row>
- <row>
- <entry>useGmtMillisForDatetimes</entry>
- <entry>Convert between session timezone and GMT before creating Date and
- Timestamp instances (value of "false" is legacy
- behavior, "true" leads to more JDBC-compliant
- behavior.</entry>
- <entry>false</entry>
- <entry>3.1.12</entry>
- </row>
- <row>
- <entry>useHostsInPrivileges</entry>
- <entry>Add '@hostname' to users in DatabaseMetaData.getColumn/TablePrivileges()
- (true/false), defaults to 'true'.</entry>
- <entry>true</entry>
- <entry>3.0.2</entry>
- </row>
- <row>
- <entry>useInformationSchema</entry>
- <entry>When connected to MySQL-5.0.7 or newer, should the driver use the
- INFORMATION_SCHEMA to derive information used by
- DatabaseMetaData?</entry>
- <entry>false</entry>
- <entry>5.0.0</entry>
- </row>
- <row>
- <entry>useJDBCCompliantTimezoneShift</entry>
- <entry>Should the driver use JDBC-compliant rules when converting
- TIME/TIMESTAMP/DATETIME values' timezone information
- for those JDBC arguments which take a
- java.util.Calendar argument? (Notice that this option
- is exclusive of the "useTimezone=true" configuration
- option.)</entry>
- <entry>false</entry>
- <entry>5.0.0</entry>
- </row>
- <row>
- <entry>useLegacyDatetimeCode</entry>
- <entry>Use code for DATE/TIME/DATETIME/TIMESTAMP handling in result sets and
- statements that consistently handles timezone
- 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?</entry>
- <entry>true</entry>
- <entry>5.1.6</entry>
- </row>
- <row>
- <entry>useOldAliasMetadataBehavior</entry>
- <entry>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.</entry>
- <entry>false</entry>
- <entry>5.0.4</entry>
- </row>
- <row>
- <entry>useOldUTF8Behavior</entry>
- <entry>Use the UTF-8 behavior the driver did when communicating with 4.0 and
- older servers</entry>
- <entry>false</entry>
- <entry>3.1.6</entry>
- </row>
- <row>
- <entry>useOnlyServerErrorMessages</entry>
- <entry>Don't prepend 'standard' SQLState error messages to error messages
- returned by the server.</entry>
- <entry>true</entry>
- <entry>3.0.15</entry>
- </row>
- <row>
- <entry>useSSPSCompatibleTimezoneShift</entry>
- <entry>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.</entry>
- <entry>false</entry>
- <entry>5.0.5</entry>
- </row>
- <row>
- <entry>useServerPrepStmts</entry>
- <entry>Use server-side prepared statements if the server supports them?</entry>
- <entry>false</entry>
- <entry>3.1.0</entry>
- </row>
- <row>
- <entry>useSqlStateCodes</entry>
- <entry>Use SQL Standard state codes instead of 'legacy' X/Open/SQL state codes
- (true/false), default is 'true'</entry>
- <entry>true</entry>
- <entry>3.1.3</entry>
- </row>
- <row>
- <entry>useStreamLengthsInPrepStmts</entry>
- <entry>Honor stream length parameter in
- PreparedStatement/ResultSet.setXXXStream() method
- calls (true/false, defaults to 'true')?</entry>
- <entry>true</entry>
- <entry>3.0.2</entry>
- </row>
- <row>
- <entry>useTimezone</entry>
- <entry>Convert time/date types between client and server timezones (true/false,
- defaults to 'false')?</entry>
- <entry>false</entry>
- <entry>3.0.2</entry>
- </row>
- <row>
- <entry>useUnbufferedInput</entry>
- <entry>Don't use BufferedInputStream for reading data from the server</entry>
- <entry>true</entry>
- <entry>3.0.11</entry>
- </row>
- <row>
- <entry>yearIsDateType</entry>
- <entry>Should the JDBC driver treat the MySQL type "YEAR" as a java.sql.Date,
- or as a SHORT?</entry>
- <entry>true</entry>
- <entry>3.1.9</entry>
- </row>
- <row>
- <entry>zeroDateTimeBehavior</entry>
- <entry>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".</entry>
- <entry>exception</entry>
- <entry>3.1.4</entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
-
- </formalpara>
-
- </cjblock>
-
</cjblock>
Modified: trunk/refman-common/connector-j-errormap.xml
===================================================================
--- trunk/refman-common/connector-j-errormap.xml 2011-01-30 18:40:05 UTC (rev 24951)
+++ trunk/refman-common/connector-j-errormap.xml 2011-01-30 19:05:17 UTC (rev 24952)
Changed blocks: 1, Lines Added: 0, Lines Deleted: 3; 767 bytes
@@ -2,9 +2,6 @@
<!DOCTYPE table PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<!-- PLEASE DO NOT EDIT THIS FILE, IT IS AUTOMATICALLY GENERATED -->
-<!DOCTYPE table PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
-<!-- PLEASE DO NOT EDIT THIS FILE, IT IS AUTOMATICALLY GENERATED -->
<table>
<title>Mapping of MySQL Error Numbers to SQLStates</title>
<tgroup cols="4">
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r24952 - in trunk: . refman-common | paul.dubois | 30 Jan |
