MySQL Bugs: #52010: Properties need appropriate documentation

Bug #52010	Properties need appropriate documentation
Submitted:	12 Mar 2010 19:30	Modified:	5 Nov 2013 13:19
Reporter:	Todd Farmer (OCA)	Email Updates:
Status:	Closed	Impact on me:	None
Category:	MySQL Cluster: Cluster/J	Severity:	S2 (Serious)
Version:	7.1.1	OS:	Any
Assigned to:	Bernd Ocklin	CPU Architecture:	Any

Description:
The only documentation I can find on Cluster/J properties is here:

http://dev.mysql.com/doc/ndbapi/en/mccj-clusterj-constants.html

Significantly more information is needed about each property:

* What each property does, explicitly
* Common use cases for when they should be set
* Allowed/valid values
* Default values
* Version introduced

Please see documentation for Connector/J as a guide:

http://dev.mysql.com/doc/refman/5.0/en/connector-j-reference-configuration-properties.html

How to repeat:
See above.

Suggested fix:
Better documentation of properties.

This is in docs generated from ClusterJ sources, therefore it must be fixed by a developer.

I've added javadoc that refers to the corresponding section of the MySQL Cluster manual.

I've added defaults so you don't need to specify all of the connection properties.

clr% bzr missing
Using saved parent location: /Users/clr/ndb/root/clusterj/
You have 1 extra revision(s):
------------------------------------------------------------
revno: 227
committer: Craig L Russell <Craig.Russell@sun.com>
branch nick: clusterj-working
timestamp: Tue 2010-03-16 12:57:52 -0700
message:
  Establish default values for connection properties except for connectstring
[CraigRussell:~/ndb/root/clusterj-working] clr% bzr push
Using saved push location: bzr+ssh://crussell@bk-internal.mysql.com/bzrroot/clusterj/
Pushed up to revision 227.                                                                                                                                                                                                          
[CraigRussell:~/ndb/root/clusterj-working] clr% pushd ../clusterj ; bzr pull ; popd
~/ndb/root/clusterj ~/ndb/root/clusterj-working 
Using saved parent location: bzr+ssh://crussell@bk-internal.mysql.com/bzrroot/clusterj/
+N  clusterj-test/src/main/java/testsuite/clusterj/DefaultConnectValuesTest.java                                                                                                                                                    
+N  clusterj-tie/src/test/java/testsuite/clusterj/tie/DefaultConnectValuesTest.java
 M  clusterj-api/src/main/java/com/mysql/clusterj/Constants.java
 M  clusterj-core/src/main/java/com/mysql/clusterj/core/SessionFactoryImpl.java
 M  clusterj-test/src/main/java/testsuite/clusterj/AbstractClusterJTest.java
All changes applied successfully.                                                                                                                                                                                                   
Now on revision 227.
~/ndb/root/clusterj-working

Please review and see if your concerns are addressed.

Thank you for your bug report. This issue has been addressed in the documentation. The updated documentation will appear on our website shortly, and will be included in the next release of the relevant products.