| List: | Commits | « Previous MessageNext Message » | |
| From: | mmatthews | Date: | July 25 2006 9:22pm |
| Subject: | svn commit - mysqldoc@docsrva: r2822 - in trunk: refman-4.1 refman-5.0 | ||
| View as plain text | |||
Author: mmatthews Date: 2006-07-25 21:22:43 +0200 (Tue, 25 Jul 2006) New Revision: 2822 Log: Updated properties table for 5.0.3 release. Modified: trunk/refman-4.1/connector-j.xml trunk/refman-5.0/connector-j.xml Modified: trunk/refman-4.1/connector-j.xml =================================================================== --- trunk/refman-4.1/connector-j.xml 2006-07-25 16:27:30 UTC (rev 2821) +++ trunk/refman-4.1/connector-j.xml 2006-07-25 19:22:43 UTC (rev 2822) Changed blocks: 1, Lines Added: 1502, Lines Deleted: 949; 97226 bytes @@ -1642,986 +1642,1539 @@ The properties are listed in the following tables. </para> -<!-- Generated by the genPropertiesTable target in the build script --> +<!-- Generated by the genPropertiesTable target in the build script - <formalpara> +Do NOT adjust the content formatting in these tables directly in this document. - <title>Connection Properties - Connection/Authentication</title> +Instead see the connPropsToDocbookXML.xsl stylesheet in the Connector/J source +distribution! - <para> - <informaltable> + --> + + <formalpara> + <title>Connection/Authentication</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>user</entry> - <entry>The user to connect as</entry> - <entry></entry> - <entry>all</entry> - </row> - <row> - <entry>password</entry> - <entry>The password to use when connecting</entry> - <entry></entry> - <entry>all</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>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> - <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>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> - <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> + <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>No</entry> + + <entry> + </entry> + + <entry>all</entry> + </row> + + <row> + <entry>password</entry> + + <entry>The password to use when connecting</entry> + + <entry>No</entry> + + <entry> + </entry> + + <entry>all</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>No</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>No</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>No</entry> + + <entry>0</entry> + + <entry>3.0.1</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>No</entry> + + <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>No</entry> + + <entry>false</entry> + + <entry>3.1.0</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>No</entry> + + <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>No</entry> + + <entry>false</entry> + + <entry>3.0.17</entry> + </row> + </tbody> </tgroup> - </informaltable> - </para> + </informaltable> + </para> + </formalpara> - </formalpara> + <formalpara> + <title>High Availability and Clustering</title> - <formalpara> + <para> + <informaltable> + <tgroup cols="4"> + <colspec colwidth="30*" colname="cj_propstbl_prop_name" /> - <title>Connection Properties - High Availability and Clustering</title> + <colspec colwidth="50*" colname="cj_propstbl_prop_defn" /> - <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'thandle - SQLExceptions properly, and is only designed to be - used when you are unable to configure your - application to handle SQLExceptions resulting from - dead andstale 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>reconnectAtTxEnd</entry> - <entry>If autoReconnect is set to true, should the driver attempt - reconnectionsat the end of every transaction?</entry> - <entry>false</entry> - <entry>3.0.10</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 to - reconnect to the master server? Whichever condition - is met first, 'queriesBeforeRetryMaster' or - 'secondsBeforeRetryMaster' will cause an attempt to - be made to reconnect to the master. Time in seconds, - defaults to 30</entry> - <entry>30</entry> - <entry>3.0.2</entry> - </row> - <row> - <entry>enableDeprecatedAutoreconnect</entry> - <entry>Auto-reconnect functionality is deprecated starting with version 3.2, - and will be removed in version 3.3. Set this - property to 'true' to disable the check for the - feature being configured.</entry> - <entry>false</entry> - <entry>3.2.1</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> - <entry>5.0.1</entry> - </row> - </tbody> + <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'thandle SQLExceptions properly, and is only designed to be used when you are unable to configure your application to handle SQLExceptions resulting from dead andstale connections properly. Alternatively, investigate setting the MySQL server variable "wait_timeout"to some high value rather than the default of 8 hours.</entry> + + <entry>No</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>No</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>No</entry> + + <entry>true</entry> + + <entry>3.0.12</entry> + </row> + + <row> + <entry>reconnectAtTxEnd</entry> + + <entry>If autoReconnect is set to true, should the driver attempt reconnectionsat the end of every transaction?</entry> + + <entry>No</entry> + + <entry>false</entry> + + <entry>3.0.10</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>No</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>No</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 to reconnect to the master server? Whichever condition is met first, 'queriesBeforeRetryMaster' or 'secondsBeforeRetryMaster' will cause an attempt to be made to reconnect to the master. Time in seconds, defaults to 30</entry> + + <entry>No</entry> + + <entry>30</entry> + + <entry>3.0.2</entry> + </row> + + <row> + <entry>enableDeprecatedAutoreconnect</entry> + + <entry>Auto-reconnect functionality is deprecated starting with version 3.2, and will be removed in version 3.3. Set this property to 'true' to disable the check for the feature being configured.</entry> + + <entry>No</entry> + + <entry>false</entry> + + <entry>3.2.1</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>No</entry> + + <entry> + </entry> + + <entry>5.0.1</entry> + </row> + </tbody> </tgroup> - </informaltable> - </para> + </informaltable> + </para> + </formalpara> - </formalpara> + <formalpara> + <title>Security</title> - <formalpara> + <para> + <informaltable> + <tgroup cols="4"> + <colspec colwidth="30*" colname="cj_propstbl_prop_name" /> - <title>Connection Properties - Security</title> + <colspec colwidth="50*" colname="cj_propstbl_prop_defn" /> - <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>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> - </tbody> + <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>No</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>No</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>No</entry> + + <entry>false</entry> + + <entry>3.1.0</entry> + </row> + + <row> + <entry>allowUrlInLocalInfile</entry> + + <entry>Should the driver allow URLs in 'LOAD DATA LOCAL INFILE' statements?</entry> + + <entry>No</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>No</entry> + + <entry>false</entry> + + <entry>3.0.1</entry> + </row> + </tbody> </tgroup> - </informaltable> - </para> + </informaltable> + </para> + </formalpara> - </formalpara> + <formalpara> + <title>Performance Extensions</title> - <formalpara> + <para> + <informaltable> + <tgroup cols="4"> + <colspec colwidth="30*" colname="cj_propstbl_prop_name" /> - <title>Connection Properties - Performance Extensions</title> + <colspec colwidth="50*" colname="cj_propstbl_prop_defn" /> - <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>metadataCacheSize</entry> - <entry>The number of queries to cacheResultSetMetadata for if - cacheResultSetMetaData is set to 'true' (default 50)</entry> - <entry>50</entry> - <entry>3.1.1</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>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>holdResultsOpenOverStatementClose</entry> - <entry>Should the driver close result sets on Statement.close() as required by - the JDBC specification?</entry> - <entry>false</entry> - <entry>3.1.7</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 optimium number of parameters - per batch and you might receive anan 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>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>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(), rather than - querying the database?</entry> - <entry>false</entry> - <entry>3.1.7</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> + <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>metadataCacheSize</entry> + + <entry>The number of queries to cacheResultSetMetadata for if cacheResultSetMetaData is set to 'true' (default 50)</entry> + + <entry>No</entry> + + <entry>50</entry> + + <entry>3.1.1</entry> + </row> + + <row> + <entry>prepStmtCacheSize</entry> + + <entry>If prepared statement caching is enabled, how many prepared statements should be cached?</entry> + + <entry>No</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>No</entry> + + <entry>256</entry> + + <entry>3.0.10</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>No</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>No</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>No</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>No</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>No</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>No</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>No</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>No</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>No</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>No</entry> + + <entry>false</entry> + + <entry>3.1.3</entry> + </row> + + <row> + <entry>holdResultsOpenOverStatementClose</entry> + + <entry>Should the driver close result sets on Statement.close() as required by the JDBC specification?</entry> + + <entry>No</entry> + + <entry>false</entry> + + <entry>3.1.7</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>No</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 optimium number of parameters per batch and you might receive anan 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>No</entry> + + <entry>false</entry> + + <entry>3.1.13</entry> + </row> + + <row> + <entry>useFastIntParsing</entry> + + <entry>Use internal String->Integer conversion routines to avoid excessive object creation?</entry> + + <entry>No</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? (The default of "true" for this is appropriate for newer JVMs</entry> + + <entry>No</entry> + + <entry>true</entry> + + <entry>5.0.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(), rather than querying the database?</entry> + + <entry>No</entry> + + <entry>false</entry> + + <entry>3.1.7</entry> + </row> + + <row> + <entry>useReadAheadInput</entry> + + <entry>Use newer, optimized non-blocking, buffered input stream when reading from the server?</entry> + + <entry>No</entry> + + <entry>true</entry> + + <entry>3.1.5</entry> + </row> + </tbody> </tgroup> - </informaltable> - </para> + </informaltable> + </para> + </formalpara> - </formalpara> + <formalpara> + <title>Debuging/Profiling</title> - <formalpara> + <para> + <informaltable> + <tgroup cols="4"> + <colspec colwidth="30*" colname="cj_propstbl_prop_name" /> - <title>Connection Properties - Debugging/Profiling</title> + <colspec colwidth="50*" colname="cj_propstbl_prop_defn" /> - <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>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>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>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>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>logSlowQueries</entry> - <entry>Should queries that take longer than 'slowQueryThresholdMillis' be - logged?</entry> - <entry>false</entry> - <entry>3.1.2</entry> - </row> - <row> - <entry>traceProtocol</entry> - <entry>Should trace-level network protocol be logged?</entry> - <entry>false</entry> - <entry>3.1.2</entry> - </row> - </tbody> + <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>No</entry> + + <entry>com.mysql.jdbc.log.StandardLogger</entry> + + <entry>3.1.1</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>No</entry> + + <entry>false</entry> + + <entry>3.1.0</entry> + </row> + + <row> + <entry>reportMetricsIntervalMillis</entry> + + <entry>If 'gatherPerfMetrics' is enabled, how often should they be logged (in ms)?</entry> + + <entry>No</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>No</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>No</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>No</entry> + + <entry>2000</entry> + + <entry>3.1.2</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>No</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>No</entry> + + <entry>false</entry> + + <entry>3.1.9</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>No</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>No</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>No</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>No</entry> + + <entry>false</entry> + + <entry>3.1.2</entry> + </row> + + <row> + <entry>logSlowQueries</entry> + + <entry>Should queries that take longer than 'slowQueryThresholdMillis' be logged?</entry> + + <entry>No</entry> + + <entry>false</entry> + + <entry>3.1.2</entry> + </row> + + <row> + <entry>traceProtocol</entry> + + <entry>Should trace-level network protocol be logged?</entry> + + <entry>No</entry> + + <entry>false</entry> + + <entry>3.1.2</entry> + </row> + </tbody> </tgroup> - </informaltable> - </para> + </informaltable> + </para> + </formalpara> - </formalpara> + <formalpara> + <title>Miscellaneous</title> - <formalpara> + <para> + <informaltable> + <tgroup cols="4"> + <colspec colwidth="30*" colname="cj_propstbl_prop_name" /> - <title>Connection Properties - Miscellaneous</title> + <colspec colwidth="50*" colname="cj_propstbl_prop_defn" /> - <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>Should the driver use Unicode character encodings when handling strings? - Should only be used when the driver can't determine - the character set mapping, or you are trying to - 'force' the driver to use a character set that MySQL - either doesn't natively support (such as UTF-8), - true/false, defaults to 'true'</entry> - <entry>true</entry> - <entry>1.1g</entry> - </row> - <row> - <entry>characterEncoding</entry> - <entry>If 'useUnicode' is set to true, what character encoding should the - driver use when dealing with strings? (defaults is - to 'autodetect')</entry> - <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> - <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> - <entry>3.0.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> - <entry>3.1.8</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>capitalizeTypeNames</entry> - <entry>Capitalize type names in DatabaseMetaData? (usually only useful when - using WebObjects, true/false, defaults to 'false')</entry> - <entry>false</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> - <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>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>N/A</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>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>Should the driver throw java.sql.DataTruncation exceptions when data is - truncated as is required by the JDBC specification - when connected to a server that supports - warnings(MySQL 4.1.0 and newer)?</entry> - <entry>true</entry> - <entry>3.1.2</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>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? (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>pedantic</entry> - <entry>Follow the JDBC spec to the letter.</entry> - <entry>false</entry> - <entry>3.0.0</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>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> - <entry>3.0.2</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>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>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>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>useServerPrepStmts</entry> - <entry>Use server-side prepared statements if the server supports them? - (defaults to 'true').</entry> - <entry>true</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> + <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>Should the driver use Unicode character encodings when handling strings? Should only be used when the driver can't determine the character set mapping, or you are trying to 'force' the driver to use a character set that MySQL either doesn't natively support (such as UTF-8), true/false, defaults to 'true'</entry> + + <entry>No</entry> + + <entry>true</entry> + + <entry>1.1g</entry> + </row> + + <row> + <entry>characterEncoding</entry> + + <entry>If 'useUnicode' is set to true, what character encoding should the driver use when dealing with strings? (defaults is to 'autodetect')</entry> + + <entry>No</entry> + + <entry> + </entry> + + <entry>1.1g</entry> + </row> + + <row> + <entry>characterSetResults</entry> + + <entry>Character set to tell the server to return results as.</entry> + + <entry>No</entry> + + <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>No</entry> + + <entry> + </entry> + + <entry>3.0.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>No</entry> + + <entry> + </entry> + + <entry>3.1.8</entry> + </row> + + <row> + <entry>allowNanAndInf</entry> + + <entry>Should the driver allow NaN or +/- INF values in PreparedStatement.setDouble()?</entry> + + <entry>No</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>No</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>No</entry> + + <entry>false</entry> + + <entry>3.1.5</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>No</entry> + + <entry>false</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>No</entry> + + <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>No</entry> + + <entry>false</entry> + + <entry>3.0.9</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>No</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>No</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>No</entry> + + <entry>true</entry> + + <entry>3.1.8</entry> + </row> + + <row> + <entry>emulateLocators</entry> + + <entry>N/A</entry> + + <entry>No</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>No</entry> + + <entry>true</entry> + + <entry>3.1.7</entry> + </row> + + <row> + <entry>ignoreNonTxTables</entry> + + <entry>Ignore non-transactional table warning for rollback? (defaults to 'false').</entry> + + <entry>No</entry> + + <entry>false</entry> + + <entry>3.0.9</entry> + </row> + + <row> + <entry>jdbcCompliantTruncation</entry> + + <entry>Should the driver throw java.sql.DataTruncation exceptions when data is truncated as is required by the JDBC specification when connected to a server that supports warnings(MySQL 4.1.0 and newer)?</entry> + + <entry>No</entry> + + <entry>true</entry> + + <entry>3.1.2</entry> + </row> + + <row> + <entry>maxRows</entry> + + <entry>The maximum number of rows to return (0, the default means return all rows).</entry> + + <entry>No</entry> + + <entry>-1</entry> + + <entry>all versions</entry> + </row> + + <row> + <entry>noDatetimeStringSync</entry> + + <entry>Don't ensure that ResultSet.getDatetimeType().toString().equals(ResultSet.getString())</entry> + + <entry>No</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>No</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? (this is not JDBC-compliant, but follows legacy behavior from earlier versions of the driver)</entry> + + <entry>No</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>No</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>No</entry> + + <entry>false</entry> + + <entry>3.1.12</entry> + </row> + + <row> + <entry>pedantic</entry> + + <entry>Follow the JDBC spec to the letter.</entry> + + <entry>No</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>No</entry> + + <entry>false</entry> + + <entry>5.0.1</entry> + </row> + + <row> + <entry>processEscapeCodesForPrepStmts</entry> + + <entry>Should the driver process escape codes in queries that are prepared?</entry> + + <entry>No</entry> + + <entry>true</entry> + + <entry>3.1.12</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>No</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>No</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>No</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>No</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>No</entry> + + <entry> + </entry> + + <entry>3.0.2</entry> + </row> + + <row> + <entry>strictFloatingPoint</entry> + + <entry>Used only in older versions of compliance test</entry> + + <entry>No</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>No</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>No</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>No</entry> + + <entry>false</entry> + + <entry>3.1.9</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>No</entry> + + <entry>false</entry> + + <entry>2.0.3</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>No</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>No</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>No</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>No</entry> + + <entry>false</entry> + + <entry>5.0.0</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>No</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>No</entry> + + <entry>true</entry> + + <entry>3.0.15</entry> + </row> + + <row> + <entry>useServerPrepStmts</entry> + + <entry>Use server-side prepared statements if the server supports them? (defaults to 'true').</entry> + + <entry>No</entry> + + <entry>true</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>No</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>No</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>No</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>No</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>No</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 zeroes (used by MySQL to represent invalid dates)? Valid values are 'exception', 'round' and 'convertToNull'.</entry> + + <entry>No</entry> + + <entry>exception</entry> + + <entry>3.1.4</entry> + </row> + </tbody> </tgroup> - </informaltable> - </para> + </informaltable> + </para> + </formalpara> - </formalpara> +<!-- End generated content --> <para> Connector/J also supports access to MySQL via named pipes on Modified: trunk/refman-5.0/connector-j.xml =================================================================== --- trunk/refman-5.0/connector-j.xml 2006-07-25 16:27:30 UTC (rev 2821) +++ trunk/refman-5.0/connector-j.xml 2006-07-25 19:22:43 UTC (rev 2822) Changed blocks: 1, Lines Added: 1502, Lines Deleted: 949; 97226 bytes @@ -1642,986 +1642,1539 @@ The properties are listed in the following tables. </para> -<!-- Generated by the genPropertiesTable target in the build script --> +<!-- Generated by the genPropertiesTable target in the build script - <formalpara> +Do NOT adjust the content formatting in these tables directly in this document. - <title>Connection Properties - Connection/Authentication</title> +Instead see the connPropsToDocbookXML.xsl stylesheet in the Connector/J source +distribution! - <para> - <informaltable> + --> + + <formalpara> + <title>Connection/Authentication</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>user</entry> - <entry>The user to connect as</entry> - <entry></entry> - <entry>all</entry> - </row> - <row> - <entry>password</entry> - <entry>The password to use when connecting</entry> - <entry></entry> - <entry>all</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>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> - <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>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> - <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> + <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>No</entry> + + <entry> + </entry> + + <entry>all</entry> + </row> + + <row> + <entry>password</entry> + + <entry>The password to use when connecting</entry> + + <entry>No</entry> + + <entry> + </entry> + + <entry>all</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>No</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>No</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>No</entry> + + <entry>0</entry> + + <entry>3.0.1</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>No</entry> + + <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>No</entry> + + <entry>false</entry> + + <entry>3.1.0</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>No</entry> + + <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>No</entry> + + <entry>false</entry> + + <entry>3.0.17</entry> + </row> + </tbody> </tgroup> - </informaltable> - </para> + </informaltable> + </para> + </formalpara> - </formalpara> + <formalpara> + <title>High Availability and Clustering</title> - <formalpara> + <para> + <informaltable> + <tgroup cols="4"> + <colspec colwidth="30*" colname="cj_propstbl_prop_name" /> - <title>Connection Properties - High Availability and Clustering</title> + <colspec colwidth="50*" colname="cj_propstbl_prop_defn" /> - <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'thandle - SQLExceptions properly, and is only designed to be - used when you are unable to configure your - application to handle SQLExceptions resulting from - dead andstale 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>reconnectAtTxEnd</entry> - <entry>If autoReconnect is set to true, should the driver attempt - reconnectionsat the end of every transaction?</entry> - <entry>false</entry> - <entry>3.0.10</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 to - reconnect to the master server? Whichever condition - is met first, 'queriesBeforeRetryMaster' or - 'secondsBeforeRetryMaster' will cause an attempt to - be made to reconnect to the master. Time in seconds, - defaults to 30</entry> - <entry>30</entry> - <entry>3.0.2</entry> - </row> - <row> - <entry>enableDeprecatedAutoreconnect</entry> - <entry>Auto-reconnect functionality is deprecated starting with version 3.2, - and will be removed in version 3.3. Set this - property to 'true' to disable the check for the - feature being configured.</entry> - <entry>false</entry> - <entry>3.2.1</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> - <entry>5.0.1</entry> - </row> - </tbody> + <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'thandle SQLExceptions properly, and is only designed to be used when you are unable to configure your application to handle SQLExceptions resulting from dead andstale connections properly. Alternatively, investigate setting the MySQL server variable "wait_timeout"to some high value rather than the default of 8 hours.</entry> + + <entry>No</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>No</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>No</entry> + + <entry>true</entry> + + <entry>3.0.12</entry> + </row> + + <row> + <entry>reconnectAtTxEnd</entry> + + <entry>If autoReconnect is set to true, should the driver attempt reconnectionsat the end of every transaction?</entry> + + <entry>No</entry> + + <entry>false</entry> + + <entry>3.0.10</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>No</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>No</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 to reconnect to the master server? Whichever condition is met first, 'queriesBeforeRetryMaster' or 'secondsBeforeRetryMaster' will cause an attempt to be made to reconnect to the master. Time in seconds, defaults to 30</entry> + + <entry>No</entry> + + <entry>30</entry> + + <entry>3.0.2</entry> + </row> + + <row> + <entry>enableDeprecatedAutoreconnect</entry> + + <entry>Auto-reconnect functionality is deprecated starting with version 3.2, and will be removed in version 3.3. Set this property to 'true' to disable the check for the feature being configured.</entry> + + <entry>No</entry> + + <entry>false</entry> + + <entry>3.2.1</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>No</entry> + + <entry> + </entry> + + <entry>5.0.1</entry> + </row> + </tbody> </tgroup> - </informaltable> - </para> + </informaltable> + </para> + </formalpara> - </formalpara> + <formalpara> + <title>Security</title> - <formalpara> + <para> + <informaltable> + <tgroup cols="4"> + <colspec colwidth="30*" colname="cj_propstbl_prop_name" /> - <title>Connection Properties - Security</title> + <colspec colwidth="50*" colname="cj_propstbl_prop_defn" /> - <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>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> - </tbody> + <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>No</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>No</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>No</entry> + + <entry>false</entry> + + <entry>3.1.0</entry> + </row> + + <row> + <entry>allowUrlInLocalInfile</entry> + + <entry>Should the driver allow URLs in 'LOAD DATA LOCAL INFILE' statements?</entry> + + <entry>No</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>No</entry> + + <entry>false</entry> + + <entry>3.0.1</entry> + </row> + </tbody> </tgroup> - </informaltable> - </para> + </informaltable> + </para> + </formalpara> - </formalpara> + <formalpara> + <title>Performance Extensions</title> - <formalpara> + <para> + <informaltable> + <tgroup cols="4"> + <colspec colwidth="30*" colname="cj_propstbl_prop_name" /> - <title>Connection Properties - Performance Extensions</title> + <colspec colwidth="50*" colname="cj_propstbl_prop_defn" /> - <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>metadataCacheSize</entry> - <entry>The number of queries to cacheResultSetMetadata for if - cacheResultSetMetaData is set to 'true' (default 50)</entry> - <entry>50</entry> - <entry>3.1.1</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>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>holdResultsOpenOverStatementClose</entry> - <entry>Should the driver close result sets on Statement.close() as required by - the JDBC specification?</entry> - <entry>false</entry> - <entry>3.1.7</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 optimium number of parameters - per batch and you might receive anan 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>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>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(), rather than - querying the database?</entry> - <entry>false</entry> - <entry>3.1.7</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> + <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>metadataCacheSize</entry> + + <entry>The number of queries to cacheResultSetMetadata for if cacheResultSetMetaData is set to 'true' (default 50)</entry> + + <entry>No</entry> + + <entry>50</entry> + + <entry>3.1.1</entry> + </row> + + <row> + <entry>prepStmtCacheSize</entry> + + <entry>If prepared statement caching is enabled, how many prepared statements should be cached?</entry> + + <entry>No</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>No</entry> + + <entry>256</entry> + + <entry>3.0.10</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>No</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>No</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>No</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>No</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>No</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>No</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>No</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>No</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>No</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>No</entry> + + <entry>false</entry> + + <entry>3.1.3</entry> + </row> + + <row> + <entry>holdResultsOpenOverStatementClose</entry> + + <entry>Should the driver close result sets on Statement.close() as required by the JDBC specification?</entry> + + <entry>No</entry> + + <entry>false</entry> + + <entry>3.1.7</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>No</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 optimium number of parameters per batch and you might receive anan 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>No</entry> + + <entry>false</entry> + + <entry>3.1.13</entry> + </row> + + <row> + <entry>useFastIntParsing</entry> + + <entry>Use internal String->Integer conversion routines to avoid excessive object creation?</entry> + + <entry>No</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? (The default of "true" for this is appropriate for newer JVMs</entry> + + <entry>No</entry> + + <entry>true</entry> + + <entry>5.0.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(), rather than querying the database?</entry> + + <entry>No</entry> + + <entry>false</entry> + + <entry>3.1.7</entry> + </row> + + <row> + <entry>useReadAheadInput</entry> + + <entry>Use newer, optimized non-blocking, buffered input stream when reading from the server?</entry> + + <entry>No</entry> + + <entry>true</entry> + + <entry>3.1.5</entry> + </row> + </tbody> </tgroup> - </informaltable> - </para> + </informaltable> + </para> + </formalpara> - </formalpara> + <formalpara> + <title>Debuging/Profiling</title> - <formalpara> + <para> + <informaltable> + <tgroup cols="4"> + <colspec colwidth="30*" colname="cj_propstbl_prop_name" /> - <title>Connection Properties - Debugging/Profiling</title> + <colspec colwidth="50*" colname="cj_propstbl_prop_defn" /> - <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>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>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>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>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>logSlowQueries</entry> - <entry>Should queries that take longer than 'slowQueryThresholdMillis' be - logged?</entry> - <entry>false</entry> - <entry>3.1.2</entry> - </row> - <row> - <entry>traceProtocol</entry> - <entry>Should trace-level network protocol be logged?</entry> - <entry>false</entry> - <entry>3.1.2</entry> - </row> - </tbody> + <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>No</entry> + + <entry>com.mysql.jdbc.log.StandardLogger</entry> + + <entry>3.1.1</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>No</entry> + + <entry>false</entry> + + <entry>3.1.0</entry> + </row> + + <row> + <entry>reportMetricsIntervalMillis</entry> + + <entry>If 'gatherPerfMetrics' is enabled, how often should they be logged (in ms)?</entry> + + <entry>No</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>No</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>No</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>No</entry> + + <entry>2000</entry> + + <entry>3.1.2</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>No</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>No</entry> + + <entry>false</entry> + + <entry>3.1.9</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>No</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>No</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>No</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>No</entry> + + <entry>false</entry> + + <entry>3.1.2</entry> + </row> + + <row> + <entry>logSlowQueries</entry> + + <entry>Should queries that take longer than 'slowQueryThresholdMillis' be logged?</entry> + + <entry>No</entry> + + <entry>false</entry> + + <entry>3.1.2</entry> + </row> + + <row> + <entry>traceProtocol</entry> + + <entry>Should trace-level network protocol be logged?</entry> + + <entry>No</entry> + + <entry>false</entry> + + <entry>3.1.2</entry> + </row> + </tbody> </tgroup> - </informaltable> - </para> + </informaltable> + </para> + </formalpara> - </formalpara> + <formalpara> + <title>Miscellaneous</title> - <formalpara> + <para> + <informaltable> + <tgroup cols="4"> + <colspec colwidth="30*" colname="cj_propstbl_prop_name" /> - <title>Connection Properties - Miscellaneous</title> + <colspec colwidth="50*" colname="cj_propstbl_prop_defn" /> - <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>Should the driver use Unicode character encodings when handling strings? - Should only be used when the driver can't determine - the character set mapping, or you are trying to - 'force' the driver to use a character set that MySQL - either doesn't natively support (such as UTF-8), - true/false, defaults to 'true'</entry> - <entry>true</entry> - <entry>1.1g</entry> - </row> - <row> - <entry>characterEncoding</entry> - <entry>If 'useUnicode' is set to true, what character encoding should the - driver use when dealing with strings? (defaults is - to 'autodetect')</entry> - <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> - <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> - <entry>3.0.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> - <entry>3.1.8</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>capitalizeTypeNames</entry> - <entry>Capitalize type names in DatabaseMetaData? (usually only useful when - using WebObjects, true/false, defaults to 'false')</entry> - <entry>false</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> - <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>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>N/A</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>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>Should the driver throw java.sql.DataTruncation exceptions when data is - truncated as is required by the JDBC specification - when connected to a server that supports - warnings(MySQL 4.1.0 and newer)?</entry> - <entry>true</entry> - <entry>3.1.2</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>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? (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>pedantic</entry> - <entry>Follow the JDBC spec to the letter.</entry> - <entry>false</entry> - <entry>3.0.0</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>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> - <entry>3.0.2</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>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>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>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>useServerPrepStmts</entry> - <entry>Use server-side prepared statements if the server supports them? - (defaults to 'true').</entry> - <entry>true</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> + <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>Should the driver use Unicode character encodings when handling strings? Should only be used when the driver can't determine the character set mapping, or you are trying to 'force' the driver to use a character set that MySQL either doesn't natively support (such as UTF-8), true/false, defaults to 'true'</entry> + + <entry>No</entry> + + <entry>true</entry> + + <entry>1.1g</entry> + </row> + + <row> + <entry>characterEncoding</entry> + + <entry>If 'useUnicode' is set to true, what character encoding should the driver use when dealing with strings? (defaults is to 'autodetect')</entry> + + <entry>No</entry> + + <entry> + </entry> + + <entry>1.1g</entry> + </row> + + <row> + <entry>characterSetResults</entry> + + <entry>Character set to tell the server to return results as.</entry> + + <entry>No</entry> + + <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>No</entry> + + <entry> + </entry> + + <entry>3.0.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>No</entry> + + <entry> + </entry> + + <entry>3.1.8</entry> + </row> + + <row> + <entry>allowNanAndInf</entry> + + <entry>Should the driver allow NaN or +/- INF values in PreparedStatement.setDouble()?</entry> + + <entry>No</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>No</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>No</entry> + + <entry>false</entry> + + <entry>3.1.5</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>No</entry> + + <entry>false</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>No</entry> + + <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>No</entry> + + <entry>false</entry> + + <entry>3.0.9</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>No</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>No</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>No</entry> + + <entry>true</entry> + + <entry>3.1.8</entry> + </row> + + <row> + <entry>emulateLocators</entry> + + <entry>N/A</entry> + + <entry>No</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>No</entry> + + <entry>true</entry> + + <entry>3.1.7</entry> + </row> + + <row> + <entry>ignoreNonTxTables</entry> + + <entry>Ignore non-transactional table warning for rollback? (defaults to 'false').</entry> + + <entry>No</entry> + + <entry>false</entry> + + <entry>3.0.9</entry> + </row> + + <row> + <entry>jdbcCompliantTruncation</entry> + + <entry>Should the driver throw java.sql.DataTruncation exceptions when data is truncated as is required by the JDBC specification when connected to a server that supports warnings(MySQL 4.1.0 and newer)?</entry> + + <entry>No</entry> + + <entry>true</entry> + + <entry>3.1.2</entry> + </row> + + <row> + <entry>maxRows</entry> + + <entry>The maximum number of rows to return (0, the default means return all rows).</entry> + + <entry>No</entry> + + <entry>-1</entry> + + <entry>all versions</entry> + </row> + + <row> + <entry>noDatetimeStringSync</entry> + + <entry>Don't ensure that ResultSet.getDatetimeType().toString().equals(ResultSet.getString())</entry> + + <entry>No</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>No</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? (this is not JDBC-compliant, but follows legacy behavior from earlier versions of the driver)</entry> + + <entry>No</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>No</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>No</entry> + + <entry>false</entry> + + <entry>3.1.12</entry> + </row> + + <row> + <entry>pedantic</entry> + + <entry>Follow the JDBC spec to the letter.</entry> + + <entry>No</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>No</entry> + + <entry>false</entry> + + <entry>5.0.1</entry> + </row> + + <row> + <entry>processEscapeCodesForPrepStmts</entry> + + <entry>Should the driver process escape codes in queries that are prepared?</entry> + + <entry>No</entry> + + <entry>true</entry> + + <entry>3.1.12</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>No</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>No</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>No</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>No</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>No</entry> + + <entry> + </entry> + + <entry>3.0.2</entry> + </row> + + <row> + <entry>strictFloatingPoint</entry> + + <entry>Used only in older versions of compliance test</entry> + + <entry>No</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>No</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>No</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>No</entry> + + <entry>false</entry> + + <entry>3.1.9</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>No</entry> + + <entry>false</entry> + + <entry>2.0.3</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>No</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>No</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>No</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>No</entry> + + <entry>false</entry> + + <entry>5.0.0</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>No</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>No</entry> + + <entry>true</entry> + + <entry>3.0.15</entry> + </row> + + <row> + <entry>useServerPrepStmts</entry> + + <entry>Use server-side prepared statements if the server supports them? (defaults to 'true').</entry> + + <entry>No</entry> + + <entry>true</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>No</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>No</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>No</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>No</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>No</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 zeroes (used by MySQL to represent invalid dates)? Valid values are 'exception', 'round' and 'convertToNull'.</entry> + + <entry>No</entry> + + <entry>exception</entry> + + <entry>3.1.4</entry> + </row> + </tbody> </tgroup> - </informaltable> - </para> + </informaltable> + </para> + </formalpara> - </formalpara> +<!-- End generated content --> <para> Connector/J also supports access to MySQL via named pipes on
| Thread | ||
|---|---|---|
| • svn commit - mysqldoc@docsrva: r2822 - in trunk: refman-4.1 refman-5.0 | mmatthews | 25 Jul |
© 1995-2008 MySQL AB, 2008-2009 Sun Microsystems, Inc.
Page generated in 1.976 sec. using MySQL 5.1.14-beta-log