Author: mcbrown
Date: 2007-03-27 16:55:20 +0200 (Tue, 27 Mar 2007)
New Revision: 5574
Log:
Updating property table after we determined the problem with the auto-generation class
that created the data.
Modified:
trunk/refman-common/connector-j.xml
Modified: trunk/refman-common/connector-j.xml
===================================================================
--- trunk/refman-common/connector-j.xml 2007-03-27 13:52:15 UTC (rev 5573)
+++ trunk/refman-common/connector-j.xml 2007-03-27 14:55:20 UTC (rev 5574)
Changed blocks: 25, Lines Added: 200, Lines Deleted: 84; 24873 bytes
@@ -1029,15 +1029,6 @@
The properties are listed in the following tables.
</para>
-<!-- Generated by the genPropertiesTable target in the build script
-
-Do NOT adjust the content structure in these tables directly in this document.
-
-Instead change the connPropsToDocbookXML.xsl stylesheet in the Connector/J source
-distribution!
-
- -->
-
<formalpara>
<title>Connection/Authentication</title>
@@ -1045,16 +1036,16 @@
<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" />
+ <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>
+ <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>
@@ -1108,6 +1099,14 @@
<entry>3.1.0</entry>
</row>
<row>
+ <entry>localSocketAddress</entry>
+ <entry>Hostname or IP address given to explicitly configure the
interface that
+ the driver will bind the client side of the TCP/IP
+ connection to when connecting.</entry>
+ <entry></entry>
+ <entry>5.0.5</entry>
+ </row>
+ <row>
<entry>propertiesTransform</entry>
<entry>An implementation of
com.mysql.jdbc.ConnectionPropertiesTransform that
the driver will use to modify URL properties passed
@@ -1136,16 +1135,16 @@
<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" />
+ <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>
+ <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>
@@ -1157,11 +1156,11 @@
connection in a new transaction. The use of this
feature is not recommended, because it has side
effects related to session state and data
- consistency when applications don't handle
+ 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 and stale connections properly. Alternatively,
+ 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>
@@ -1183,6 +1182,13 @@
<entry>3.0.12</entry>
</row>
<row>
+ <entry>maxReconnects</entry>
+ <entry>Maximum number of reconnects to attempt if autoReconnect
is true,
+ default is '3'.</entry>
+ <entry>3</entry>
+ <entry>1.1</entry>
+ </row>
+ <row>
<entry>reconnectAtTxEnd</entry>
<entry>If autoReconnect is set to true, should the driver attempt
reconnectionsat the end of every transaction?</entry>
@@ -1190,6 +1196,13 @@
<entry>3.0.10</entry>
</row>
<row>
+ <entry>initialTimeout</entry>
+ <entry>If autoReconnect is enabled, the initial time to wait
between re-connect
+ attempts (in seconds, defaults to '2').</entry>
+ <entry>2</entry>
+ <entry>1.1</entry>
+ </row>
+ <row>
<entry>roundRobinLoadBalance</entry>
<entry>When autoReconnect is enabled, and failoverReadonly is
false, should we
pick hosts to connect to on a round-robin basis?</entry>
@@ -1219,15 +1232,6 @@
<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
@@ -1251,21 +1255,21 @@
<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" />
+ <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>
+ <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>
+ (true/false), defaults to 'false'</entry>
<entry>false</entry>
<entry>3.1.1</entry>
</row>
@@ -1283,6 +1287,13 @@
<entry>3.1.0</entry>
</row>
<row>
+ <entry>allowLoadLocalInfile</entry>
+ <entry>Should the driver allow use of 'LOAD DATA LOCAL INFILE...'
(defaults to
+ 'true').</entry>
+ <entry>true</entry>
+ <entry>3.0.3</entry>
+ </row>
+ <row>
<entry>allowUrlInLocalInfile</entry>
<entry>Should the driver allow URLs in 'LOAD DATA LOCAL INFILE'
statements?</entry>
<entry>false</entry>
@@ -1310,18 +1321,25 @@
<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" />
+ <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>
+ <entry><emphasis role="bold"> Property Name
</emphasis></entry>
+ <entry><emphasis role="bold"> Definition
</emphasis></entry>
+ <entry><emphasis role="bold"> Default Value
</emphasis></entry>
+ <entry><emphasis role="bold"> Since Version
</emphasis></entry>
</row>
<row>
+ <entry>callableStmtCacheSize</entry>
+ <entry>If 'cacheCallableStmts' is enabled, how many callable
statements should
+ be cached?</entry>
+ <entry>100</entry>
+ <entry>3.1.2</entry>
+ </row>
+ <row>
<entry>metadataCacheSize</entry>
<entry>The number of queries to cacheResultSetMetadata for if
cacheResultSetMetaData is set to 'true' (default 50)</entry>
@@ -1343,6 +1361,30 @@
<entry>3.0.10</entry>
</row>
<row>
+ <entry>alwaysSendSetIsolation</entry>
+ <entry>Should the driver always communicate with the database
when
+ Connection.setTransactionIsolation() is called? If
+ set to false, the driver will only communicate with
+ the database when the requested transaction
+ isolation is different than the whichever is newer,
+ the last value that was set via
+ Connection.setTransactionIsolation(), or the value
+ that was read from the server when the connection
+ was established.</entry>
+ <entry>true</entry>
+ <entry>3.1.7</entry>
+ </row>
+ <row>
+ <entry>maintainTimeStats</entry>
+ <entry>Should the driver maintain various internal timers to
enable idle time
+ calculations as well as more verbose error messages
+ when the connection to the server fails? Setting
+ this property to false removes at least two calls to
+ System.getCurrentTimeMillis() per query.</entry>
+ <entry>true</entry>
+ <entry>3.1.9</entry>
+ </row>
+ <row>
<entry>useCursorFetch</entry>
<entry>If connected to MySQL > 5.0.2, and setFetchSize()
> 0 on a
statement, should that statement use cursor-based
@@ -1422,6 +1464,20 @@
<entry>3.1.3</entry>
</row>
<row>
+ <entry>enableQueryTimeouts</entry>
+ <entry>When enabled, query timeouts set via
Statement.setQueryTimeout() use a
+ shared java.util.Timer instance for scheduling. Even
+ if the timeout doesn't expire before the query is
+ processed, there will be memory used by the
+ TimerTask for the given timeout which won't be
+ reclaimed until the time the timeout would have
+ expired if it hadn't been cancelled by the driver.
+ High-load environments might want to consider
+ disabling this functionality.</entry>
+ <entry>true</entry>
+ <entry>5.0.6</entry>
+ </row>
+ <row>
<entry>holdResultsOpenOverStatementClose</entry>
<entry>Should the driver close result sets on Statement.close()
as required by
the JDBC specification?</entry>
@@ -1440,13 +1496,11 @@
<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
+ prepared statements for INSERT and REPLACE into
+ multi-value inserts/replaces 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 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
@@ -1459,6 +1513,13 @@
<entry>3.1.13</entry>
</row>
<row>
+ <entry>useFastDateParsing</entry>
+ <entry>Use internal String->Date/Time/Teimstamp conversion
routines to avoid
+ excessive object creation?</entry>
+ <entry>true</entry>
+ <entry>5.0.5</entry>
+ </row>
+ <row>
<entry>useFastIntParsing</entry>
<entry>Use internal String->Integer conversion routines to
avoid excessive
object creation?</entry>
@@ -1469,9 +1530,8 @@
<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>true</entry>
+ sets?</entry>
+ <entry>false</entry>
<entry>5.0.1</entry>
</row>
<row>
@@ -1505,16 +1565,16 @@
<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" />
+ <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>
+ <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>
@@ -1526,6 +1586,14 @@
<entry>3.1.1</entry>
</row>
<row>
+ <entry>gatherPerfMetrics</entry>
+ <entry>Should the driver gather performance metrics, and report
them via the
+ configured logger every
+ 'reportMetricsIntervalMillis' milliseconds?</entry>
+ <entry>false</entry>
+ <entry>3.1.2</entry>
+ </row>
+ <row>
<entry>profileSQL</entry>
<entry>Trace queries and their execution/fetch times to the
configured logger
(true/false) defaults to 'false'</entry>
@@ -1533,6 +1601,14 @@
<entry>3.1.0</entry>
</row>
<row>
+ <entry>profileSql</entry>
+ <entry>Deprecated, use 'profileSQL' instead. Trace queries and
their
+ execution/fetch times on STDERR (true/false)
+ defaults to 'false'</entry>
+ <entry></entry>
+ <entry>2.0.14</entry>
+ </row>
+ <row>
<entry>reportMetricsIntervalMillis</entry>
<entry>If 'gatherPerfMetrics' is enabled, how often should they
be logged (in
ms)?</entry>
@@ -1612,6 +1688,21 @@
<entry>3.1.2</entry>
</row>
<row>
+ <entry>logXaCommands</entry>
+ <entry>Should the driver log XA commands sent by
MysqlXaConnection to the
+ server, at the DEBUG level of logging?</entry>
+ <entry>false</entry>
+ <entry>5.0.5</entry>
+ </row>
+ <row>
+ <entry>resultSetSizeThreshold</entry>
+ <entry>If the usage advisor is enabled, how many rows should a
result set
+ contain before the driver warns that it is
+ suspiciously large?</entry>
+ <entry>100</entry>
+ <entry>5.0.5</entry>
+ </row>
+ <row>
<entry>traceProtocol</entry>
<entry>Should trace-level network protocol be
logged?</entry>
<entry>false</entry>
@@ -1631,16 +1722,16 @@
<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" />
+ <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>
+ <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>
@@ -1764,6 +1855,16 @@
<entry>3.1.7</entry>
</row>
<row>
+ <entry>generateSimpleParameterMetadata</entry>
+ <entry>Should the driver generate simplified parameter metadata
for
+ PreparedStatements when no metadata is available
+ either because the server couldn't support preparing
+ the statement, or server-side prepared statements
+ are disabled?</entry>
+ <entry>false</entry>
+ <entry>5.0.5</entry>
+ </row>
+ <row>
<entry>ignoreNonTxTables</entry>
<entry>Ignore non-transactional table warning for rollback?
(defaults to
'false').</entry>
@@ -1932,6 +2033,13 @@
<entry>3.1.9</entry>
</row>
<row>
+ <entry>treatUtilDateAsTimestamp</entry>
+ <entry>Should the driver treat java.util.Date as a TIMESTAMP for
the purposes
+ of PreparedStatement.setObject()?</entry>
+ <entry>true</entry>
+ <entry>5.0.5</entry>
+ </row>
+ <row>
<entry>ultraDevHack</entry>
<entry>Create PreparedStatements for prepareCall() when required,
because
UltraDev is broken and issues a prepareCall() for
@@ -1999,10 +2107,20 @@
<entry>3.0.15</entry>
</row>
<row>
+ <entry>useSSPSCompatibleTimezoneShift</entry>
+ <entry>If migrating from an environment that was using
server-side prepared
+ statements, and the configuration property
+ "useJDBCCompliantTimeZoneShift" set to "true", use
+ compatible behavior when not using server-side
+ prepared statements when sending TIMESTAMP values to
+ the MySQL server.</entry>
+ <entry>false</entry>
+ <entry>5.0.5</entry>
+ </row>
+ <row>
<entry>useServerPrepStmts</entry>
- <entry>Use server-side prepared statements if the server supports
them?
- (defaults to 'true').</entry>
- <entry>true</entry>
+ <entry>Use server-side prepared statements if the server supports
them?</entry>
+ <entry>false</entry>
<entry>3.1.0</entry>
</row>
<row>
@@ -2056,8 +2174,6 @@
</formalpara>
-<!-- End generated content -->
-
<para>
Connector/J also supports access to MySQL via named pipes on
Windows NT/2000/XP using the
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r5574 - trunk/refman-common | mcbrown | 27 Mar |