[CONJ-951] Documentation for Connector-J property keys is not updated Created: 2022-03-29  Updated: 2022-05-23

Status: Open
Project: MariaDB Connector/J
Component/s: documentation
Affects Version/s: 3.0.3, 3.0.4
Fix Version/s: None

Type: Bug Priority: Major
Reporter: Javier Martín Assignee: Diego Dupin
Resolution: Unresolved Votes: 0
Labels: None


 Description   

The release notes for Connector-J 3.0.3 mention that some connection options have been removed, with comments/explanations and a few suggested replacements. However, the general documentation for Connector-J is not updated as of today and still shows the old parameters as being valid for the latest release.

Note that this issue is made worse by the fact that the driver does not throw when passing unrecognized options, they merely remain in Configuration.nonMappedOptions(). Thus, users could be very confused when they pass the options described in the documentation but they do not take effect.

At least the following parameters are misdocumented:

  • New, missing documentation: (that I know of)
    • sslMode, which replaces a set of other properties that are still accepted
    • timezone
  • Removed, still in documentation:
    • allowMasterDownConnection
    • assureReadOnly
    • autoReconnect
    • cachePrepStmts
    • callableStmtCacheSize
    • enablePacketDebug
    • failoverLoopRetries
    • jdbcCompliantTruncation
    • keyPassword
    • loadBalanceBlacklistTimeout
    • log
    • passwordCharacterEncoding
    • prepStmtCacheSqlLimit
    • profileSql
    • retriesAllDown
    • rewriteBatchedStatements
    • serverTimezone
    • sharedMemory
    • slowQueryThresholdNanos
    • staticGlobal
    • tcpNoDelay
    • tcpRcvBuf
    • tcpSndBuf
    • trackSchema
    • trustStore
    • trustStorePassword
    • trustStoreType
    • useBatchMultiSend
    • useBatchMultiSendNumber
    • useFractionalSeconds
    • useOldAliasMetadataBehavior
    • validConnectionTimeout

 Comments   
Comment by Javier Martín [ 2022-05-09 ]

It seems the documentation was updated, and the current version has most changes applied:

  • It does list all the removed options above in a new "removed" section.
  • The "sslMode" option is now properly described.
  • The documentation for the "timezone" parameter is still missing

I would say the issue could be either retargeted just to the missing "timezone" documentation, or even closed so that a specific "timezone" documentation request can be created.

Either way, thanks a lot for the documentation change!

Comment by Diego Dupin [ 2022-05-23 ]

about timezone option : see https://mariadb.com/kb/en/about-mariadb-connector-j/#timezone-consideration

Generated at Thu Feb 08 03:19:31 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.