-
Type:
Improvement
-
Resolution: Done
-
Priority:
Trivial - P5
-
Affects Version/s: None
-
Component/s: None
-
Empty show more show less
Hi.
IMO the node-mongodb-native connection settings documentation could really do with some attention. There are currently mistakes, ambiguities, and a lack of important information (or links to info).
http://mongodb.github.io/node-mongodb-native/2.0/reference/connecting/connection-settings/
Some examples:
When using 2.0? Or only when using 2.0 with replica sets?replSet, Options that modify the Replicaset topology connection behavior. This is a required parameter when using the 2.0 driver
What does this do exactly? A link to further documentation would be great.ha Boolean, default:true, turn on high availability.
What is the value, Secs, ms?haInterval Number, default:5000, time between each replicaset status check.
"socketOptions.keepAlive, Number, default: 0 TCP KeepAlive on the socket with a X ms delay before start." What is X? How does this relate to OS values like tcp_keepalive_time, tcp_keepalive_intvl, tcp_keepalive_probes?
Is 'retryMiliSeconds' intentional? If so, document should acknowledge that the incorrect spelling should be used.retryMiliSeconds Number, default:5000, number of milliseconds between retries.
A typo I assume?If you are connecting to a MongoDB replicaset, you pass the parameters using the mongos options field.
Some links to more informtion about these would be very useful.socketOptions