Wednesday, 17 February 2016

[JDBC] MySQL JDBC Driver Properties

MySQL DBC Driver

Property NameDescriptionReqiredChoicesSample Value
HOSTHostname of MySQL Servertrue192.168.0.88
PORTPort number of MySQL Serverfalse3306
DBNAMEDatabase namefalsewin_mys
userUsername to authenticate astruebizteco
passwordPassword to use for authenticationtruebtc7btc
allowLoadLocalInfileShould the driver allow use of 'LOAD DATA LOCAL INFILE...' (defaults to 'true').false
true
false
yes
no
true
allowMultiQueriesAllow the use of ';' to delimit multiple queries during one statement (true/false), defaults to 'false', and does not affect the addBatch() and executeBatch() methods, which instead rely on rewriteBatchStatements.false
true
false
yes
no
false
allowNanAndInfShould the driver allow NaN or +/- INF values in PreparedStatement.setDouble()?false
true
false
yes
no
false
allowUrlInLocalInfileShould the driver allow URLs in 'LOAD DATA LOCAL INFILE' statements?false
true
false
yes
no
false
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. Note that useLocalSessionState=true will force the same behavior as alwaysSendSetIsolation=false, regardless of how alwaysSendSetIsolation is set.false
true
false
yes
no
true
autoClosePStmtStreamsShould the driver automatically call .close() on streams/readers passed as arguments via set*() methods?false
true
false
yes
no
false
autoDeserializeShould the driver automatically detect and de-serialize objects stored in BLOB fields?false
true
false
yes
no
false
autoGenerateTestcaseScriptShould the driver dump the SQL it is executing, including server-side prepared statements to STDERR?false
true
false
yes
no
false
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, as a last option, investigate setting the MySQL server variable "wait_timeout" to a high value, rather than the default of 8 hours.false
true
false
yes
no
false
autoReconnectForPoolsUse a reconnection strategy appropriate for connection pools (defaults to 'false')false
true
false
yes
no
false
blobSendChunkSizeChunk to use when sending BLOB/CLOBs via ServerPreparedStatementsfalse1048576
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?false
true
false
yes
no
true
blobsAreStringsShould the driver always treat BLOBs as Strings - specifically to work around dubious metadata returned by the server for GROUP BY clauses?false
true
false
yes
no
false
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?false
true
false
yes
no
false
cacheCallableStmtsShould the driver cache the parsing stage of CallableStatementsfalse
true
false
yes
no
false
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?false
true
false
yes
no
false
cacheResultSetMetadataShould the driver cache ResultSetMetaData for Statements and PreparedStatements? (Req. JDK-1.4+, true/false, default 'false')false
true
false
yes
no
false
cacheServerConfigurationShould the driver cache the results of 'SHOW VARIABLES' and 'SHOW COLLATION' on a per-URL basis?false
true
false
yes
no
false
callableStmtCacheSizeIf 'cacheCallableStmts' is enabled, how many callable statements should be cached?false100
capitalizeTypeNamesCapitalize type names in DatabaseMetaData? (usually only useful when using WebObjects, true/false, defaults to 'false')false
true
false
yes
no
true
characterEncodingIf 'useUnicode' is set to true, what character encoding should the driver use when dealing with strings? (defaults is to 'autodetect')falsenull
characterSetResultsCharacter set to tell the server to return results as.falsenull
clientInfoProviderThe name of a class that implements the com.mysql.jdbc.JDBC4ClientInfoProvider interface in order to support JDBC-4.0's Connection.get/setClientInfo() methodsfalsecom.mysql.jdbc.JDBC4CommentClientInfoProvider
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.false
true
false
yes
no
false
clobCharacterEncodingThe character encoding to use for sending and retrieving TEXT, MEDIUMTEXT and LONGTEXT values instead of the configured connection characterEncodingfalsenull
compensateOnDuplicateKeyUpdateCountsShould the driver compensate for the update counts of "ON DUPLICATE KEY" INSERT statements (2 = 1, 0 = 1) when using prepared statements?false
true
false
yes
no
false
connectionCollationIf set, tells the server to use this collation via 'set collation_connection'falsenull
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.falsenull
connectTimeoutTimeout for socket connect (in milliseconds), with 0 being no timeout. Only works on JDK-1.4 or newer. Defaults to '0'.false0
continueBatchOnErrorShould the driver continue processing batch commands if one statement fails. The JDBC spec allows either way (defaults to 'true').false
true
false
yes
no
true
createDatabaseIfNotExistCreates the database given in the URL if it doesn't yet exist. Assumes the configured user has permissions to create databases.false
true
false
yes
no
false
defaultFetchSizeThe driver will call setFetchSize(n) with this value on all newly-created Statementsfalse0
useServerPrepStmtsUse server-side prepared statements if the server supports them?false
true
false
yes
no
false
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.false
true
false
yes
no
false
dumpQueriesOnExceptionShould the driver dump the contents of the query sent to the server in the message for SQLExceptions?false
true
false
yes
no
false
dynamicCalendarsShould the driver retrieve the default calendar when required, or cache it per connection/session?false
true
false
yes
no
false
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)?false
true
false
yes
no
false
emptyStringsConvertToZeroShould the driver allow conversions from empty string fields to numeric values of '0'?false
true
false
yes
no
true
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. false
true
false
yes
no
false
emulateUnsupportedPstmtsShould the driver detect prepared statements that are not supported by the server, and replace them with client-side emulated versions?false
true
false
yes
no
true
enablePacketDebugWhen enabled, a ring-buffer of 'packetDebugBufferSize' packets will be kept, and dumped when exceptions are thrown in key areas in the driver's codefalse
true
false
yes
no
false
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.false
true
false
yes
no
true
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?false
true
false
yes
no
false
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.falsenull
failOverReadOnlyWhen failing over in autoReconnect mode, should the connection be set to 'read-only'?false
true
false
yes
no
true
gatherPerfMetricsShould the driver gather performance metrics, and report them via the configured logger every 'reportMetricsIntervalMillis' milliseconds?false
true
false
yes
no
false
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?false
true
false
yes
no
false
holdResultsOpenOverStatementCloseShould the driver close result sets on Statement.close() as required by the JDBC specification?false
true
false
yes
no
false
includeInnodbStatusInDeadlockExceptionsInclude the output of "SHOW ENGINE INNODB STATUS" in exception messages when deadlock exceptions are detected?false
true
false
yes
no
false
includeThreadDumpInDeadlockExceptionsInclude a current Java thread dump in exception messages when deadlock exceptions are detected?false
true
false
yes
no
false
includeThreadNamesAsStatementCommentInclude the name of the current thread as a comment visible in "SHOW PROCESSLIST", or in Innodb deadlock dumps, useful in correlation with "includeInnodbStatusInDeadlockExceptions=true" and "includeThreadDumpInDeadlockExceptions=true". false
true
false
yes
no
false
ignoreNonTxTablesIgnore non-transactional table warning for rollback? (defaults to 'false').false
true
false
yes
no
false
initialTimeoutIf autoReconnect is enabled, the initial time to wait between re-connect attempts (in seconds, defaults to '2').false2
interactiveClientSet the CLIENT_INTERACTIVE flag, which tells MySQL to timeout connections based on INTERACTIVE_TIMEOUT instead of WAIT_TIMEOUTfalse
true
false
yes
no
false
jdbcCompliantTruncationShould the driver throw java.sql.DataTruncation exceptions when data is truncated as is required by the JDBC specification when connected to a server that supports warnings (MySQL 4.1.0 and newer)? This property has no effect if the server sql-mode includes STRICT_TRANS_TABLES.false
true
false
yes
no
true
largeRowSizeThresholdWhat size result set row should the JDBC driver consider "large", and thus use a more memory-efficient way of representing the row internally?false2048
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.falserandom
loadBalanceBlacklistTimeoutTime in milliseconds between checks of servers which are unavailable, by controlling how long a server lives in the global blacklist.false0
loadBalancePingTimeoutTime in milliseconds to wait for ping response from each of load-balanced physical connections when using load-balanced Connection.false0
loadBalanceValidateConnectionOnSwapServerShould the load-balanced Connection explicitly check whether the connection is live when swapping to a new physical connection at commit/rollback?false
true
false
yes
no
false
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.falsenull
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.falsecom.mysql.jdbc.StandardLoadBalanceExceptionChecker
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.falsenull
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.falsenull
loadBalanceEnableJMXEnables JMX-based management of load-balanced connection groups, including live addition/removal of hosts from load-balancing pool.false
true
false
yes
no
false
loadBalanceAutoCommitStatementRegexWhen load-balancing is enabled for auto-commit statements (via loadBalanceAutoCommitStatementThreshold), the statement counter will only increment when the SQL matches the regular expression. By default, every statement issued matches.falsenull
loadBalanceAutoCommitStatementThresholdWhen auto-commit is enabled, the number of statements which should be executed before triggering load-balancing to rebalance. Default value of 0 causes load-balanced connections to only rebalance when exceptions are encountered, or auto-commit is disabled and transactions are explicitly committed or rolled back.false0
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.falsenull
locatorFetchBufferSizeIf 'emulateLocators' is configured to 'true', what size buffer should be used when fetching BLOB data for getBinaryInputStream?false1048576
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)falsecom.mysql.jdbc.log.StandardLogger
logSlowQueriesShould queries that take longer than 'slowQueryThresholdMillis' be logged?false
true
false
yes
no
false
logXaCommandsShould the driver log XA commands sent by MysqlXaConnection to the server, at the DEBUG level of logging?false
true
false
yes
no
false
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.false
true
false
yes
no
true
maxQuerySizeToLogControls the maximum length/size of a query that will get logged when profiling or tracingfalse2048
maxReconnectsMaximum number of reconnects to attempt if autoReconnect is true, default is '3'.false3
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.false120
maxRowsThe maximum number of rows to return (0, the default means return all rows).false-1
metadataCacheSizeThe number of queries to cache ResultSetMetadata for if cacheResultSetMetaData is set to 'true' (default 50)false50
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)false600
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?false
true
false
yes
no
false
noDatetimeStringSyncDon't ensure that ResultSet.getDatetimeType().toString().equals(ResultSet.getString())false
true
false
yes
no
false
noTimezoneConversionForTimeTypeDon't convert TIME values using the server timezone if 'useTimezone'='true'false
true
false
yes
no
false
nullCatalogMeansCurrentWhen 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)false
true
false
yes
no
true
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)false
true
false
yes
no
true
packetDebugBufferSizeThe maximum number of packets to retain when 'enablePacketDebug' is truefalse20
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)?false
true
false
yes
no
false
paranoidTake measures to prevent exposure sensitive information in error messages and clear data structures holding sensitive data when possible? (defaults to 'false')false
true
false
yes
no
false
pedanticFollow the JDBC spec to the letter.false
true
false
yes
no
false
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 calledfalse
true
false
yes
no
false
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.false
true
false
yes
no
false
prepStmtCacheSizeIf prepared statement caching is enabled, how many prepared statements should be cached?false25
prepStmtCacheSqlLimitIf prepared statement caching is enabled, what's the largest SQL the driver will cache the parsing for?false256
parseInfoCacheFactoryName of a class implementing com.mysql.jdbc.CacheAdapterFactory, which will be used to create caches for the parsed representation of client-side prepared statements.falsecom.mysql.jdbc.PerConnectionLRUFactory
processEscapeCodesForPrepStmtsShould the driver process escape codes in queries that are prepared?false
true
false
yes
no
true
profilerEventHandlerName of a class that implements the interface com.mysql.jdbc.profiler.ProfilerEventHandler that will be used to handle profiling/tracing events.falsecom.mysql.jdbc.profiler.LoggingProfilerEventHandler
profileSqlDeprecated, use 'profileSQL' instead. Trace queries and their execution/fetch times on STDERR (true/false) defaults to 'false'falsenull
profileSQLTrace queries and their execution/fetch times to the configured logger (true/false) defaults to 'false'false
true
false
yes
no
false
propertiesTransformAn implementation of com.mysql.jdbc.ConnectionPropertiesTransform that the driver will use to modify URL properties passed to the driver before attempting a connectionfalsenull
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.false50
queryTimeoutKillsConnectionIf the timeout given in Statement.setQueryTimeout() expires, should the driver forcibly abort the Connection instead of attempting to abort the query?false
true
false
yes
no
false
reconnectAtTxEndIf autoReconnect is set to true, should the driver attempt reconnections at the end of every transaction?false
true
false
yes
no
false
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')?false
true
false
yes
no
false
reportMetricsIntervalMillisIf 'gatherPerfMetrics' is enabled, how often should they be logged (in ms)?false30000
requireSSLRequire SSL connection if useSSL=true? (defaults to 'false').false
true
false
yes
no
false
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 URLfalsenull
resultSetSizeThresholdIf the usage advisor is enabled, how many rows should a result set contain before the driver warns that it is suspiciously large?false100
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.false
true
false
yes
no
false
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.false
true
false
yes
no
false
rollbackOnPooledCloseShould the driver issue a rollback() when the logical connection in a pool is closed?false
true
false
yes
no
true
roundRobinLoadBalanceWhen autoReconnect is enabled, and failoverReadonly is false, should we pick hosts to connect to on a round-robin basis?false
true
false
yes
no
false
runningCTS13Enables workarounds for bugs in Sun's JDBC compliance testsuite version 1.3false
true
false
yes
no
false
secondsBeforeRetryMasterHow long should the driver wait, when failed over, before attempting false30
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.false0
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.false0
serverTimezoneOverride detection/mapping of timezone. Used when timezone from server doesn't map to Java timezonefalsenull
sessionVariablesA comma-separated list of name/value pairs to be sent as SET SESSION ... to the server when the driver connects.falsenull
slowQueryThresholdMillisIf 'logSlowQueries' is enabled, how long should a query (in ms) before it is logged as 'slow'?false2000
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.false0
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.falsecom.mysql.jdbc.StandardSocketFactory
socketTimeoutTimeout on network socket operations (0, the default means no timeout).false0
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. falsenull
strictFloatingPointUsed only in older versions of compliance testfalse
true
false
yes
no
false
strictUpdatesShould the driver do strict checking (all primary keys selected) of updatable result sets (true, false, defaults to 'true')?false
true
false
yes
no
true
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)?false
true
false
yes
no
false
tcpNoDelayIf connecting using TCP/IP, should the driver set SO_TCP_NODELAY (disabling the Nagle Algorithm)?false
true
false
yes
no
true
tcpKeepAliveIf connecting using TCP/IP, should the driver set SO_KEEPALIVE?false
true
false
yes
no
true
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)false0
tcpSndBufIf connecting using TCP/IP, should the driver set SO_SND_BUF to the given value? The default value of '0', means use the platform default value for this property)false0
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.false0
tinyInt1isBitShould the driver treat the datatype TINYINT(1) as the BIT type (because the server silently converts BIT -> TINYINT(1) when creating tables)?false
true
false
yes
no
true
traceProtocolShould trace-level network protocol be logged?false
true
false
yes
no
false
treatUtilDateAsTimestampShould the driver treat java.util.Date as a TIMESTAMP for the purposes of PreparedStatement.setObject()?false
true
false
yes
no
true
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?false
true
false
yes
no
false
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.false
true
false
yes
no
false
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.falsenull
utf8OutsideBmpIncludedColumnNamePatternUsed to specify exclusion rules to "utf8OutsideBmpExcludedColumnNamePattern". The regex must follow the patterns used for the java.util.regex package.falsenull
useCompressionUse zlib compression when communicating with the server (true/false)? Defaults to 'false'.false
true
false
yes
no
false
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.false
true
false
yes
no
false
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.falsenull
useCursorFetchIf connected to MySQL > 5.0.2, and setFetchSize() > 0 on a statement, should that statement use cursor-based fetching to retrieve rows?false
true
false
yes
no
false
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?false
true
false
yes
no
true
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.false
true
false
yes
no
true
useFastIntParsingUse internal String->Integer conversion routines to avoid excessive object creation?false
true
false
yes
no
true
useFastDateParsingUse internal String->Date/Time/Timestamp conversion routines to avoid excessive object creation?false
true
false
yes
no
true
useHostsInPrivilegesAdd '@hostname' to users in DatabaseMetaData.getColumn/TablePrivileges() (true/false), defaults to 'true'.false
true
false
yes
no
true
useInformationSchemaWhen connected to MySQL-5.0.7 or newer, should the driver use the INFORMATION_SCHEMA to derive information used by DatabaseMetaData?false
true
false
yes
no
false
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.)false
true
false
yes
no
false
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?false
true
false
yes
no
false
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?false
true
false
yes
no
false
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?false
true
false
yes
no
true
useNanosForElapsedTimeFor profiling/debugging functionality that measures elapsed time, should the driver try to use nanoseconds resolution if available (JDK >= 1.5)?false
true
false
yes
no
false
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.false
true
false
yes
no
false
useOldUTF8BehaviorUse the UTF-8 behavior the driver did when communicating with 4.0 and older serversfalse
true
false
yes
no
false
useOnlyServerErrorMessagesDon't prepend 'standard' SQLState error messages to error messages returned by the server.false
true
false
yes
no
true
useReadAheadInputUse newer, optimized non-blocking, buffered input stream when reading from the server?false
true
false
yes
no
true
useSqlStateCodesUse SQL Standard state codes instead of 'legacy' X/Open/SQL state codes (true/false), default is 'true'false
true
false
yes
no
true
useSSLUse SSL when communicating with the server (true/false), defaults to 'false'false
true
false
yes
no
false
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.false
true
false
yes
no
false
useStreamLengthsInPrepStmtsHonor stream length parameter in PreparedStatement/ResultSet.setXXXStream() method calls (true/false, defaults to 'true')?false
true
false
yes
no
true
useTimezoneConvert time/date types between client and server timezones (true/false, defaults to 'false')?false
true
false
yes
no
false
ultraDevHackCreate PreparedStatements for prepareCall() when required, because UltraDev is broken and issues a prepareCall() for _all_ statements? (true/false, defaults to 'false')false
true
false
yes
no
false
useUnbufferedInputDon't use BufferedInputStream for reading data from the serverfalse
true
false
yes
no
true
useUnicodeShould 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'false
true
false
yes
no
true
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')?false
true
false
yes
no
false
yearIsDateTypeShould the JDBC driver treat the MySQL type "YEAR" as a java.sql.Date, or as a SHORT?false
true
false
yes
no
true
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".false
exception
round
convertToNull
exception
useJvmCharsetConvertersAlways use the character encoding routines built into the JVM, rather than using lookup tables for single-byte character sets?false
true
false
yes
no
false
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.false
true
false
yes
no
false
dumpMetadataOnColumnNotFoundShould the driver dump the field-level metadata of a result set into the exception message when ResultSet.findColumn() fails?false
true
false
yes
no
false
clientCertificateKeyStoreUrlURL to the client certificate KeyStore (if not specified, use defaults)falsenull
trustCertificateKeyStoreUrlURL to the trusted root certificate KeyStore (if not specified, use defaults)falsenull
clientCertificateKeyStoreTypeKeyStore type for client certificates (NULL or empty means use the default, which is "JKS". Standard keystore types supported by the JVM are "JKS" and "PKCS12", your environment may have more available depending on what security products are installed and available to the JVM.falseJKS
clientCertificateKeyStorePasswordPassword for the client certificates KeyStorefalsenull
trustCertificateKeyStoreTypeKeyStore type for trusted root certificates (NULL or empty means use the default, which is "JKS". Standard keystore types supported by the JVM are "JKS" and "PKCS12", your environment may have more available depending on what security products are installed and available to the JVM.falseJKS
trustCertificateKeyStorePasswordPassword for the trusted root certificates KeyStorefalsenull
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.false
true
false
yes
no
true
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.false
true
false
yes
no
false
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.falsenull
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'.false-1
authenticationPluginsComma-delimited list of classes that implement com.mysql.jdbc.AuthenticationPlugin and which will be used for authentication unless disabled by "disabledAuthenticationPlugins" property.falsenull
disabledAuthenticationPluginsComma-delimited list of classes implementing com.mysql.jdbc.AuthenticationPlugin or mechanisms, i.e. "mysql_native_password". The authentication plugins or mechanisms listed will not be used for authentication which will fail if it requires one of them. It is an error to disable the default authentication plugin (either the one named by "defaultAuthenticationPlugin" property or the hard-coded one if "defaultAuthenticationPlugin" propery is not set).falsenull
defaultAuthenticationPluginName of a class implementing com.mysql.jdbc.AuthenticationPlugin which will be used as the default authentication plugin (see below). It is an error to use a class which is not listed in "authenticationPlugins" nor it is one of the built-in plugins. It is an error to set as default a plugin which was disabled with "disabledAuthenticationPlugins" property. It is an error to set this value to null or the empty string (i.e. there must be at least a valid default authentication plugin specified for the connection, meeting all constraints listed above).falsecom.mysql.jdbc.authentication.MysqlNativePasswordPlugin

No comments:

Post a Comment