Uploaded image for project: 'Node.js Driver'
  1. Node.js Driver
  2. NODE-583

node-mongodb-native connection settings documentation poor quality.

    • Type: Icon: Improvement Improvement
    • Resolution: Done
    • Priority: Icon: Trivial - P5 Trivial - P5
    • 2.1.11
    • Affects Version/s: None
    • Component/s: None

      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:

      replSet, Options that modify the Replicaset topology connection behavior. This is a required parameter when using the 2.0 driver

      When using 2.0? Or only when using 2.0 with replica sets?

      ha Boolean, default:true, turn on high availability.

      What does this do exactly? A link to further documentation would be great.

      haInterval Number, default:5000, time between each replicaset status check.

      What is the value, Secs, ms?

      "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?

      retryMiliSeconds Number, default:5000, number of milliseconds between retries.

      Is 'retryMiliSeconds' intentional? If so, document should acknowledge that the incorrect spelling should be used.

      If you are connecting to a MongoDB replicaset, you pass the parameters using the mongos options field.

      A typo I assume?

      socketOptions

      Some links to more informtion about these would be very useful.

            Assignee:
            Unassigned Unassigned
            Reporter:
            bgsosh@gmail.com Scott Lowe
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved: