22.3.4.1. Driver/Datasource Class Names, URL Syntax and Configuration Properties for Connector/J

The name of the class that implements java.sql.Driver in MySQL Connector/J is com.mysql.jdbc.Driver. The org.gjt.mm.mysql.Driver class name is also usable to remain backward-compatible with MM.MySQL. You should use this class name when registering the driver, or when otherwise configuring software to use MySQL Connector/J.

The JDBC URL format for MySQL Connector/J is as follows, with items in square brackets ([, ]) being optional:

jdbc:mysql://[host][,failoverhost...][:port]/[database] »
[?propertyName1][=propertyValue1][&propertyName2][=propertyValue2]...

If the host name is not specified, it defaults to 127.0.0.1. If the port is not specified, it defaults to 3306, the default port number for MySQL servers.

jdbc:mysql://[host:port],[host:port].../[database] »
[?propertyName1][=propertyValue1][&propertyName2][=propertyValue2]...

If the database is not specified, the connection will be made with no default database. In this case, you will need to either call the setCatalog() method on the Connection instance or fully specify table names using the database name (that is, SELECT dbname.tablename.colname FROM dbname.tablename...) in your SQL. Not specifying the database to use upon connection is generally only useful when building tools that work with multiple databases, such as GUI database managers.

Note

JDBC clients should never employ the USE database statement to specify the desired database, they should always use the Connection.setCatalog() method instead.

MySQL Connector/J has fail-over support. This enables the driver to fail-over to any number of slave hosts and still perform read-only queries. Fail-over only happens when the connection is in an autoCommit(true) state, because fail-over can not happen reliably when a transaction is in progress. Most application servers and connection pools set autoCommit to true at the end of every transaction/connection use.

The fail-over functionality has the following behavior:

  • If the URL property autoReconnect is false: Failover only happens at connection initialization, and failback occurs when the driver determines that the first host has become available again.

  • If the URL property autoReconnect is true: Failover happens when the driver determines that the connection has failed (before every query), and falls back to the first host when it determines that the host has become available again (after queriesBeforeRetryMaster queries have been issued).

In either case, whenever you are connected to a "failed-over" server, the connection will be set to read-only state, so queries that would modify data will have exceptions thrown (the query will never be processed by the MySQL server).

Configuration properties define how Connector/J will make a connection to a MySQL server. Unless otherwise noted, properties can be set for a DataSource object or for a Connection object.

Configuration Properties can be set in one of the following ways:

  • Using the set*() methods on MySQL implementations of java.sql.DataSource (which is the preferred method when using implementations of java.sql.DataSource):

    • com.mysql.jdbc.jdbc2.optional.MysqlDataSource

    • com.mysql.jdbc.jdbc2.optional.MysqlConnectionPoolDataSource

  • As a key/value pair in the java.util.Properties instance passed to DriverManager.getConnection() or Driver.connect()

  • As a JDBC URL parameter in the URL given to java.sql.DriverManager.getConnection(), java.sql.Driver.connect() or the MySQL implementations of the javax.sql.DataSource setURL() method.

    Note

    If the mechanism you use to configure a JDBC URL is XML-based, you will need to use the XML character literal & to separate configuration parameters, as the ampersand is a reserved character for XML.

The properties are listed in the following tables.

Connection/Authentication. 

Property Name Definition Default Value Since Version
userThe user to connect as all versions
passwordThe password to use when connecting all versions
socketFactoryThe 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.com.mysql.jdbc.StandardSocketFactory3.0.3
connectTimeoutTimeout for socket connect (in milliseconds), with 0 being no timeout. Only works on JDK-1.4 or newer. Defaults to '0'.03.0.1
socketTimeoutTimeout on network socket operations (0, the default means no timeout).03.0.1
connectionLifecycleInterceptorsA comma-delimited list of classes that implement "com.mysql.jdbc.ConnectionLifecycleInterceptor" that should notified of connection lifecycle events (creation, destruction, commit, rollback, setCatalog and setAutoCommit) and potentially alter the execution of these commands. ConnectionLifecycleInterceptors are "stackable", more than one interceptor may be specified via the configuration property as a comma-delimited list, with the interceptors executed in order from left to right. 5.1.4
useConfigsLoad 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. 3.1.5
interactiveClientSet the CLIENT_INTERACTIVE flag, which tells MySQL to timeout connections based on INTERACTIVE_TIMEOUT instead of WAIT_TIMEOUTfalse3.1.0
localSocketAddressHostname 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. 5.0.5
propertiesTransformAn implementation of com.mysql.jdbc.ConnectionPropertiesTransform that the driver will use to modify URL properties passed to the driver before attempting a connection 3.1.4
useCompressionUse zlib compression when communicating with the server (true/false)? Defaults to 'false'.false3.0.17

Networking. 

Property Name Definition Default Value Since Version
maxAllowedPacketMaximum allowed packet size to send to server. If not set, the value of system variable 'max_allowed_packet' will be used to initialize this upon connecting. This value will not take effect if set larger than the value of 'max_allowed_packet'.-15.1.8
tcpKeepAliveIf connecting using TCP/IP, should the driver set SO_KEEPALIVE?true5.0.7
tcpNoDelayIf connecting using TCP/IP, should the driver set SO_TCP_NODELAY (disabling the Nagle Algorithm)?true5.0.7
tcpRcvBufIf connecting using TCP/IP, should the driver set SO_RCV_BUF to the given value? The default value of '0', means use the platform default value for this property)05.0.7
tcpSndBufIf connecting using TCP/IP, shuold the driver set SO_SND_BUF to the given value? The default value of '0', means use the platform default value for this property)05.0.7
tcpTrafficClassIf connecting using TCP/IP, should the driver set traffic class or type-of-service fields ?See the documentation for java.net.Socket.setTrafficClass() for more information.05.0.7

High Availability and Clustering. 

Property Name Definition Default Value Since Version
autoReconnectShould the driver try to re-establish stale and/or dead connections? If enabled the driver will throw an exception for a queries issued on a stale or dead connection, which belong to the current transaction, but will attempt reconnect before the next query issued on the connection in a new transaction. The use of this feature is not recommended, because it has side effects related to session state and data consistency when applications don't handle SQLExceptions properly, and is only designed to be used when you are unable to configure your application to handle SQLExceptions resulting from dead and stale connections properly. Alternatively, investigate setting the MySQL server variable "wait_timeout" to some high value rather than the default of 8 hours.false1.1
autoReconnectForPoolsUse a reconnection strategy appropriate for connection pools (defaults to 'false')false3.1.3
failOverReadOnlyWhen failing over in autoReconnect mode, should the connection be set to 'read-only'?true3.0.12
maxReconnectsMaximum number of reconnects to attempt if autoReconnect is true, default is '3'.31.1
reconnectAtTxEndIf autoReconnect is set to true, should the driver attempt reconnections at the end of every transaction?false3.0.10
retriesAllDownWhen using loadbalancing, the number of times the driver should cycle through available hosts, attempting to connect. Between cycles, the driver will pause for 250ms if no servers are available.1205.1.6
initialTimeoutIf autoReconnect is enabled, the initial time to wait between re-connect attempts (in seconds, defaults to '2').21.1
roundRobinLoadBalanceWhen autoReconnect is enabled, and failoverReadonly is false, should we pick hosts to connect to on a round-robin basis?false3.1.2
queriesBeforeRetryMasterNumber 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.503.0.2
secondsBeforeRetryMasterHow long should the driver wait, when failed over, before attempting303.0.2
selfDestructOnPingMaxOperations=If set to a non-zero value, the driver will report close the connection and report failure when Connection.ping() or Connection.isValid(int) is called if the connnection's count of commands sent to the server exceeds this value.05.1.6
selfDestructOnPingSecondsLifetimeIf set to a non-zero value, the driver will report close the connection and report failure when Connection.ping() or Connection.isValid(int) is called if the connnection's lifetime exceeds this value.05.1.6
resourceIdA 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 5.0.1

Security. 

Property Name Definition Default Value Since Version
allowMultiQueriesAllow the use of ';' to delimit multiple queries during one statement (true/false), defaults to 'false'false3.1.1
useSSLUse SSL when communicating with the server (true/false), defaults to 'false'false3.0.2
requireSSLRequire SSL connection if useSSL=true? (defaults to 'false').false3.1.0
verifyServerCertificateIf "useSSL" is set to "true", should the driver verify the server's certificate? When using this feature, the keystore parameters should be specified by the "clientCertificateKeyStore*" properties, rather than system properties.true5.1.6
clientCertificateKeyStoreUrlURL to the client certificate KeyStore (if not specified, use defaults) 5.1.0
clientCertificateKeyStoreTypeKeyStore type for client certificates (NULL or empty means use default, standard keystore types supported by the JVM are "JKS" and "PKCS12", your environment may have more available depending on what security products are installed and available to the JVM. 5.1.0
clientCertificateKeyStorePasswordPassword for the client certificates KeyStore 5.1.0
trustCertificateKeyStoreUrlURL to the trusted root certificate KeyStore (if not specified, use defaults) 5.1.0
trustCertificateKeyStoreTypeKeyStore type for trusted root certificates (NULL or empty means use default, standard keystore types supported by the JVM are "JKS" and "PKCS12", your environment may have more available depending on what security products are installed and available to the JVM. 5.1.0
trustCertificateKeyStorePasswordPassword for the trusted root certificates KeyStore 5.1.0
allowLoadLocalInfileShould the driver allow use of 'LOAD DATA LOCAL INFILE...' (defaults to 'true').true3.0.3
allowUrlInLocalInfileShould the driver allow URLs in 'LOAD DATA LOCAL INFILE' statements?false3.1.4
paranoidTake measures to prevent exposure sensitive information in error messages and clear data structures holding sensitive data when possible? (defaults to 'false')false3.0.1
passwordCharacterEncodingWhat character encoding is used for passwords? Leaving this set to the default value (null), uses the platform character set, which works for ISO8859_1 (i.e. "latin1") passwords. For passwords in other character encodings, the encoding will have to be specified with this property, as it's not possible for the driver to auto-detect this. 5.1.7

Performance Extensions. 

Property Name Definition Default Value Since Version
callableStmtCacheSizeIf 'cacheCallableStmts' is enabled, how many callable statements should be cached?1003.1.2
metadataCacheSizeThe number of queries to cache ResultSetMetadata for if cacheResultSetMetaData is set to 'true' (default 50)503.1.1
useLocalSessionStateShould the driver refer to the internal values of autocommit and transaction isolation that are set by Connection.setAutoCommit() and Connection.setTransactionIsolation() and transaction state as maintained by the protocol, rather than querying the database or blindly sending commands to the database for commit() or rollback() method calls?false3.1.7
useLocalTransactionStateShould the driver use the in-transaction state provided by the MySQL protocol to determine if a commit() or rollback() should actually be sent to the database?false5.1.7
prepStmtCacheSizeIf prepared statement caching is enabled, how many prepared statements should be cached?253.0.10
prepStmtCacheSqlLimitIf prepared statement caching is enabled, what's the largest SQL the driver will cache the parsing for?2563.0.10
alwaysSendSetIsolationShould 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.true3.1.7
maintainTimeStatsShould 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.true3.1.9
useCursorFetchIf connected to MySQL > 5.0.2, and setFetchSize() > 0 on a statement, should that statement use cursor-based fetching to retrieve rows?false5.0.0
blobSendChunkSizeChunk to use when sending BLOB/CLOBs via ServerPreparedStatements10485763.1.9
cacheCallableStmtsShould the driver cache the parsing stage of CallableStatementsfalse3.1.2
cachePrepStmtsShould 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?false3.0.10
cacheResultSetMetadataShould the driver cache ResultSetMetaData for Statements and PreparedStatements? (Req. JDK-1.4+, true/false, default 'false')false3.1.1
cacheServerConfigurationShould the driver cache the results of 'SHOW VARIABLES' and 'SHOW COLLATION' on a per-URL basis?false3.1.5
defaultFetchSizeThe driver will call setFetchSize(n) with this value on all newly-created Statements03.1.9
dontTrackOpenResourcesThe 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.false3.1.7
dynamicCalendarsShould the driver retrieve the default calendar when required, or cache it per connection/session?false3.1.5
elideSetAutoCommitsIf 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)?false3.1.3
enableQueryTimeoutsWhen 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.true5.0.6
holdResultsOpenOverStatementCloseShould the driver leave the result sets open on Statement.close() (enabling violates JDBC specification)false3.1.7
largeRowSizeThresholdWhat size result set row should the JDBC driver consider "large", and thus use a more memory-efficient way of representing the row internally?20485.1.1
loadBalanceStrategyIf using a load-balanced connection to connect to SQL nodes in a MySQL Cluster/NDB configuration (by using the URL prefix "jdbc:mysql:loadbalance://"), which load balancing algorithm should the driver use: (1) "random" - the driver will pick a random host for each request. This tends to work better than round-robin, as the randomness will somewhat account for spreading loads where requests vary in response time, while round-robin can sometimes lead to overloaded nodes if there are variations in response times across the workload. (2) "bestResponseTime" - the driver will route the request to the host that had the best response time for the previous transaction.random5.0.6
locatorFetchBufferSizeIf 'emulateLocators' is configured to 'true', what size buffer should be used when fetching BLOB data for getBinaryInputStream?10485763.2.1
rewriteBatchedStatementsShould the driver use multiqueries (irregardless of the setting of "allowMultiQueries") as well as rewriting of prepared statements for INSERT into multi-value inserts when executeBatch() is called? Notice that this has the potential for SQL injection if using plain java.sql.Statements and your code doesn't sanitize input correctly. Notice that for prepared statements, server-side prepared statements can not currently take advantage of this rewrite option, and that if you don't specify stream lengths when using PreparedStatement.set*Stream(), the driver won't be able to determine the optimum number of parameters per batch and you might receive an error from the driver that the resultant packet is too large. Statement.getGeneratedKeys() for these rewritten statements only works when the entire batch includes INSERT statements.false3.1.13
useDirectRowUnpackUse newer result set row unpacking code that skips a copy from network buffers to a MySQL packet instance and instead reads directly into the result set row data buffers.true5.1.1
useDynamicCharsetInfoShould the driver use a per-connection cache of character set information queried from the server when necessary, or use a built-in static mapping that is more efficient, but isn't aware of custom character sets or character sets implemented after the release of the JDBC driver?true5.0.6
useFastDateParsingUse internal String->Date/Time/Timestamp conversion routines to avoid excessive object creation?true5.0.5
useFastIntParsingUse internal String->Integer conversion routines to avoid excessive object creation?true3.1.4
useJvmCharsetConvertersAlways use the character encoding routines built into the JVM, rather than using lookup tables for single-byte character sets?false5.0.1
useReadAheadInputUse newer, optimized non-blocking, buffered input stream when reading from the server?true3.1.5

Debugging/Profiling. 

Property Name Definition Default Value Since Version
loggerThe 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)com.mysql.jdbc.log.StandardLogger3.1.1
gatherPerfMetricsShould the driver gather performance metrics, and report them via the configured logger every 'reportMetricsIntervalMillis' milliseconds?false3.1.2
profileSQLTrace queries and their execution/fetch times to the configured logger (true/false) defaults to 'false'false3.1.0
profileSqlDeprecated, use 'profileSQL' instead. Trace queries and their execution/fetch times on STDERR (true/false) defaults to 'false' 2.0.14
reportMetricsIntervalMillisIf 'gatherPerfMetrics' is enabled, how often should they be logged (in ms)?300003.1.2
maxQuerySizeToLogControls the maximum length/size of a query that will get logged when profiling or tracing20483.1.3
packetDebugBufferSizeThe maximum number of packets to retain when 'enablePacketDebug' is true203.1.3
slowQueryThresholdMillisIf 'logSlowQueries' is enabled, how long should a query (in ms) before it is logged as 'slow'?20003.1.2
slowQueryThresholdNanosIf 'useNanosForElapsedTime' is set to true, and this property is set to a non-zero value, the driver will use this threshold (in nanosecond units) to determine if a query was slow.05.0.7
useUsageAdvisorShould the driver issue 'usage' warnings advising proper and efficient usage of JDBC and MySQL Connector/J to the log (true/false, defaults to 'false')?false3.1.1
autoGenerateTestcaseScriptShould the driver dump the SQL it is executing, including server-side prepared statements to STDERR?false3.1.9
autoSlowLogInstead of using slowQueryThreshold* to determine if a query is slow enough to be logged, maintain statistics that allow the driver to determine queries that are outside the 99th percentile?true5.1.4
clientInfoProviderThe name of a class that implements the com.mysql.jdbc.JDBC4ClientInfoProvider interface in order to support JDBC-4.0's Connection.get/setClientInfo() methodscom.mysql.jdbc.JDBC4CommentClientInfoProvider5.1.0
dumpMetadataOnColumnNotFoundShould the driver dump the field-level metadata of a result set into the exception message when ResultSet.findColumn() fails?false3.1.13
dumpQueriesOnExceptionShould the driver dump the contents of the query sent to the server in the message for SQLExceptions?false3.1.3
enablePacketDebugWhen enabled, a ring-buffer of 'packetDebugBufferSize' packets will be kept, and dumped when exceptions are thrown in key areas in the driver's codefalse3.1.3
explainSlowQueriesIf '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?false3.1.2
includeInnodbStatusInDeadlockExceptionsInclude the output of "SHOW ENGINE INNODB STATUS" in exception messages when deadlock exceptions are detected?false5.0.7
logSlowQueriesShould queries that take longer than 'slowQueryThresholdMillis' be logged?false3.1.2
logXaCommandsShould the driver log XA commands sent by MysqlXaConnection to the server, at the DEBUG level of logging?false5.0.5
profilerEventHandlerName of a class that implements the interface com.mysql.jdbc.profiler.ProfilerEventHandler that will be used to handle profiling/tracing events.com.mysql.jdbc.profiler.LoggingProfilerEventHandler5.1.6
resultSetSizeThresholdIf the usage advisor is enabled, how many rows should a result set contain before the driver warns that it is suspiciously large?1005.0.5
traceProtocolShould trace-level network protocol be logged?false3.1.2
useNanosForElapsedTimeFor profiling/debugging functionality that measures elapsed time, should the driver try to use nanoseconds resolution if available (JDK >= 1.5)?false5.0.7

Miscellaneous. 

Property Name Definition Default Value Since Version
useUnicodeForces the driver to use Unicode character encodings. Should only be set to false either when the driver can't determine the character set mapping (in which case, specify the Java character encoding in the characterEncoding property), or you are trying to force the driver to use a character set that MySQL doesn't natively support. Should be 'true' for all versions of MySQL 4.1 or higher unless you are trying to emulate the character set handling support provided in MySQL 4.0. Value is true/false, defaults to 'true'true1.1g
characterEncodingIf 'useUnicode' is set to true, what Java character encoding should the driver use when dealing with strings? (defaults is to 'autodetect'). If the encoding cannot be determined, then an exception will be raised. 1.1g
characterSetResultsCharacter set to tell the server to return results as. 3.0.13
connectionCollationIf set, tells the server to use this collation via 'set collation_connection' 3.0.13
useBlobToStoreUTF8OutsideBMPTells the driver to treat [MEDIUM/LONG]BLOB columns as [LONG]VARCHAR columns holding text encoded in UTF-8 that has characters outside the BMP (4-byte encodings), which MySQL server can't handle natively.false5.1.3
utf8OutsideBmpExcludedColumnNamePatternWhen "useBlobToStoreUTF8OutsideBMP" is set to "true", column names matching the given regex will still be treated as BLOBs unless they match the regex specified for "utf8OutsideBmpIncludedColumnNamePattern". The regex must follow the patterns used for the java.util.regex package. 5.1.3
utf8OutsideBmpIncludedColumnNamePatternUsed to specify exclusion rules to "utf8OutsideBmpExcludedColumnNamePattern". The regex must follow the patterns used for the java.util.regex package. 5.1.3
loadBalanceEnableJMXEnables JMX-based management of load-balanced connection groups, including live addition/removal of hosts from load-balancing pool.false5.1.13
sessionVariablesA comma-separated list of name/value pairs to be sent as SET SESSION ... to the server when the driver connects. 3.1.8
useColumnNamesInFindColumnPrior to JDBC-4.0, the JDBC specification had a bug related to what could be given as a "column name" to ResultSet methods like findColumn(), or getters that took a String property. JDBC-4.0 clarified "column name" to mean the label, as given in an "AS" clause and returned by ResultSetMetaData.getColumnLabel(), and if no AS clause, the column name. Setting this property to "true" will give behavior that is congruent to JDBC-3.0 and earlier versions of the JDBC specification, but which because of the specification bug could give unexpected results. This property is preferred over "useOldAliasMetadataBehavior" unless you need the specific behavior that it provides with respect to ResultSetMetadata.false5.1.7
allowNanAndInfShould the driver allow NaN or +/- INF values in PreparedStatement.setDouble()?false3.1.5
autoClosePStmtStreamsShould the driver automatically call .close() on streams/readers passed as arguments via set*() methods?false3.1.12
autoDeserializeShould the driver automatically detect and de-serialize objects stored in BLOB fields?false3.1.5
blobsAreStringsShould the driver always treat BLOBs as Strings - specifically to work around dubious metadata returned by the server for GROUP BY clauses?false5.0.8
capitalizeTypeNamesCapitalize type names in DatabaseMetaData? (usually only useful when using WebObjects, true/false, defaults to 'false')true2.0.7
clobCharacterEncodingThe character encoding to use for sending and retrieving TEXT, MEDIUMTEXT and LONGTEXT values instead of the configured connection characterEncoding 5.0.0
clobberStreamingResultsThis 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.false3.0.9
compensateOnDuplicateKeyUpdateCountsShould the driver compensate for the update counts of "ON DUPLICATE KEY" INSERT statements (2 = 1, 0 = 1) when using prepared statements?false5.1.7
continueBatchOnErrorShould the driver continue processing batch commands if one statement fails. The JDBC spec allows either way (defaults to 'true').true3.0.3
createDatabaseIfNotExistCreates the database given in the URL if it doesn't yet exist. Assumes the configured user has permissions to create databases.false3.1.9
emptyStringsConvertToZeroShould the driver allow conversions from empty string fields to numeric values of '0'?true3.1.8
emulateLocatorsShould the driver emulate java.sql.Blobs with locators? With this feature enabled, the driver will delay loading the actual Blob data until the one of the retrieval methods (getInputStream(), getBytes(), and so forth) on the blob data stream has been accessed. For this to work, you must use a column alias with the value of the column to the actual name of the Blob. The feature also has the following restrictions: The SELECT that created the result set must reference only one table, the table must have a primary key; the SELECT must alias the original blob column name, specified as a string, to an alternate name; the SELECT must cover all columns that make up the primary key.false3.1.0
emulateUnsupportedPstmtsShould the driver detect prepared statements that are not supported by the server, and replace them with client-side emulated versions?true3.1.7
exceptionInterceptorsComma-delimited list of classes that implement com.mysql.jdbc.ExceptionInterceptor. These classes will be instantiated one per Connection instance, and all SQLExceptions thrown by the driver will be allowed to be intercepted by these interceptors, in a chained fashion, with the first class listed as the head of the chain. 5.1.8
functionsNeverReturnBlobsShould the driver always treat data from functions returning BLOBs as Strings - specifically to work around dubious metadata returned by the server for GROUP BY clauses?false5.0.8
generateSimpleParameterMetadataShould 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?false5.0.5
ignoreNonTxTablesIgnore non-transactional table warning for rollback? (defaults to 'false').false3.0.9
jdbcCompliantTruncationThis sets whether Connector/J should throw java.sql.DataTruncation exceptions when data is truncated. This is required by the JDBC specification when connected to a server that supports warnings (MySQL 4.1.0 and newer). This property has no effect if the server sql-mode includes STRICT_TRANS_TABLES. Note that if STRICT_TRANS_TABLES is not set, it will be set as a result of using this connection string option.true3.1.2
loadBalanceBlacklistTimeoutTime in milliseconds between checks of servers which are unavailable.05.1.0
loadBalanceConnectionGroupLogical group of load-balanced connections within a classloader, used to manage different groups independently. If not specified, live management of load-balanced connections is disabled. 5.1.13
loadBalanceExceptionCheckerFully-qualified class name of custom exception checker. The class must implement com.mysql.jdbc.LoadBalanceExceptionChecker interface, and is used to inspect SQLExceptions and determine whether they should trigger fail-over to another host in a load-balanced deployment.com.mysql.jdbc.StandardLoadBalanceExceptionChecker5.1.13
loadBalancePingTimeoutTime in milliseconds to wait for ping response from each of load-balanced physical connections when using load-balanced Connection.05.1.13
loadBalanceSQLExceptionSubclassFailoverComma-delimited list of classes/interfaces used by default load-balanced exception checker to determine whether a given SQLException should trigger failover. The comparison is done using Class.isInstance(SQLException) using the thrown SQLException. 5.1.13
loadBalanceSQLStateFailoverComma-delimited list of SQLState codes used by default load-balanced exception checker to determine whether a given SQLException should trigger failover. The SQLState of a given SQLException is evaluated to determine whether it begins with any value in the comma-delimited list. 5.1.13
loadBalanceValidateConnectionOnSwapServerShould the load-balanced Connection explicitly check whether the connection is live when swapping to a new physical connection at commit/rollback?false5.1.13
maxRowsThe maximum number of rows to return (0, the default means return all rows).-1all versions
netTimeoutForStreamingResultsWhat value should the driver automatically set the server setting 'net_write_timeout' to when the streaming result sets feature is in use? (value has unit of seconds, the value '0' means the driver will not try and adjust this value)6005.1.0
noAccessToProcedureBodiesWhen determining procedure parameter types for CallableStatements, and the connected user can't access procedure bodies through "SHOW CREATE PROCEDURE" or select on mysql.proc should the driver instead create basic metadata (all parameters reported as IN VARCHARs, but allowing registerOutParameter() to be called on them anyway) instead of throwing an exception?false5.0.3
noDatetimeStringSyncDon't ensure that ResultSet.getDatetimeType().toString().equals(ResultSet.getString())false3.1.7
noTimezoneConversionForTimeTypeDon't convert TIME values using the server timezone if 'useTimezone'='true'false5.0.0
nullCatalogMeansCurrentWhen DatabaseMetadataMethods ask for a 'catalog' parameter, does the value null mean use the current catalog? When nullCatalogMeansCurrent is true the current catalog will be used if the catalog parameter is null. If nullCatalogMeansCurrent is false and the catalog parameter is null then the catalog parameter is not used to restrict the catalog search. (This is not JDBC-compliant, but follows legacy behavior from earlier versions of the driver)true3.1.8
nullNamePatternMatchesAllShould 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)true3.1.8
overrideSupportsIntegrityEnhancementFacilityShould 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)?false3.1.12
padCharsWithSpaceIf a result set column has the CHAR type and the value does not fill the amount of characters specified in the DDL for the column, should the driver pad the remaining characters with space (for ANSI compliance)?false5.0.6
pedanticFollow the JDBC spec to the letter.false3.0.0
pinGlobalTxToPhysicalConnectionWhen 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 calledfalse5.0.1
populateInsertRowWithDefaultValuesWhen using ResultSets that are CONCUR_UPDATABLE, should the driver pre-populate the "insert" row with default values from the DDL for the table used in the query so those values are immediately available for ResultSet accessors? This functionality requires a call to the database for metadata each time a result set of this type is created. If disabled (the default), the default values will be populated by the an internal call to refreshRow() which pulls back default values and/or values changed by triggers.false5.0.5
processEscapeCodesForPrepStmtsShould the driver process escape codes in queries that are prepared?true3.1.12
queryTimeoutKillsConnectionIf the timeout given in Statement.setQueryTimeout() expires, should the driver forcibly abort the Connection instead of attempting to abort the query?false5.1.9
relaxAutoCommitIf 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')?false2.0.13
retainStatementAfterResultSetCloseShould the driver retain the Statement reference in a ResultSet after ResultSet.close() has been called. This is not JDBC-compliant after JDBC-4.0.false3.1.11
rollbackOnPooledCloseShould the driver issue a rollback() when the logical connection in a pool is closed?true3.0.15
runningCTS13Enables workarounds for bugs in Sun's JDBC compliance testsuite version 1.3false3.1.7
serverTimezoneOverride detection/mapping of timezone. Used when timezone from server doesn't map to Java timezone 3.0.2
statementInterceptorsA comma-delimited list of classes that implement "com.mysql.jdbc.StatementInterceptor" that should be placed "in between" query execution to influence the results. StatementInterceptors are "chainable", the results returned by the "current" interceptor will be passed on to the next in in the chain, from left-to-right order, as specified in this property. 5.1.1
strictFloatingPointUsed only in older versions of compliance testfalse3.0.0
strictUpdatesShould the driver do strict checking (all primary keys selected) of updatable result sets (true, false, defaults to 'true')?true3.0.4
tinyInt1isBitShould the driver treat the datatype TINYINT(1) as the BIT type (because the server silently converts BIT -> TINYINT(1) when creating tables)?true3.0.16
transformedBitIsBooleanIf 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?false3.1.9
treatUtilDateAsTimestampShould the driver treat java.util.Date as a TIMESTAMP for the purposes of PreparedStatement.setObject()?true5.0.5
ultraDevHackCreate PreparedStatements for prepareCall() when required, because UltraDev is broken and issues a prepareCall() for _all_ statements? (true/false, defaults to 'false')false2.0.3
useAffectedRowsDon't set the CLIENT_FOUND_ROWS flag when connecting to the server (not JDBC-compliant, will break most applications that rely on "found" rows vs. "affected rows" for DML statements), but does cause "correct" update counts from "INSERT ... ON DUPLICATE KEY UPDATE" statements to be returned by the server.false5.1.7
useGmtMillisForDatetimesConvert between session timezone and GMT before creating Date and Timestamp instances (value of "false" is legacy behavior, "true" leads to more JDBC-compliant behavior.false3.1.12
useHostsInPrivilegesAdd '@hostname' to users in DatabaseMetaData.getColumn/TablePrivileges() (true/false), defaults to 'true'.true3.0.2
useInformationSchemaWhen connected to MySQL-5.0.7 or newer, should the driver use the INFORMATION_SCHEMA to derive information used by DatabaseMetaData?false5.0.0
useJDBCCompliantTimezoneShiftShould 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.)false5.0.0
useLegacyDatetimeCodeUse code for DATE/TIME/DATETIME/TIMESTAMP handling in result sets and statements that consistently handles timezone conversions from client to server and back again, or use the legacy code for these datatypes that has been in the driver for backwards-compatibility?true5.1.6
useOldAliasMetadataBehaviorShould the driver use the legacy behavior for "AS" clauses on columns and tables, and only return aliases (if any) for ResultSetMetaData.getColumnName() or ResultSetMetaData.getTableName() rather than the original column/table name? In 5.0.x, the default value was true.false5.0.4
useOldUTF8BehaviorUse the UTF-8 behavior the driver did when communicating with 4.0 and older serversfalse3.1.6
useOnlyServerErrorMessagesDon't prepend 'standard' SQLState error messages to error messages returned by the server.true3.0.15
useSSPSCompatibleTimezoneShiftIf 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.false5.0.5
useServerPrepStmtsUse server-side prepared statements if the server supports them?false3.1.0
useSqlStateCodesUse SQL Standard state codes instead of 'legacy' X/Open/SQL state codes (true/false), default is 'true'true3.1.3
useStreamLengthsInPrepStmtsHonor stream length parameter in PreparedStatement/ResultSet.setXXXStream() method calls (true/false, defaults to 'true')?true3.0.2
useTimezoneConvert time/date types between client and server timezones (true/false, defaults to 'false')?false3.0.2
useUnbufferedInputDon't use BufferedInputStream for reading data from the servertrue3.0.11
yearIsDateTypeShould the JDBC driver treat the MySQL type "YEAR" as a java.sql.Date, or as a SHORT?true3.1.9
zeroDateTimeBehaviorWhat 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".exception3.1.4

Connector/J also supports access to MySQL using named pipes on Windows NT/2000/XP using the NamedPipeSocketFactory as a plugin-socket factory using the socketFactory property. If you do not use a namedPipePath property, the default of '\\.\pipe\MySQL' will be used. If you use the NamedPipeSocketFactory, the host name and port number values in the JDBC url will be ignored. You can enable this feature using:

socketFactory=com.mysql.jdbc.NamedPipeSocketFactory
        

Named pipes only work when connecting to a MySQL server on the same physical machine as the one the JDBC driver is being used on. In simple performance tests, it appears that named pipe access is between 30%-50% faster than the standard TCP/IP access. However, this varies per system, and named pipes are slower than TCP/IP in many Windows configurations.

You can create your own socket factories by following the example code in com.mysql.jdbc.NamedPipeSocketFactory, or com.mysql.jdbc.StandardSocketFactory.

Copyright © 2010-2024 Platon Technologies, s.r.o.           Home | Man pages | tLDP | Documents | Utilities | About
Design by styleshout