Improve runCommand API documentation

XMLWordPrintableJSON

    • Type: Improvement
    • Resolution: Done
    • Priority: Minor - P4
    • 3.1.0
    • Affects Version/s: None
    • Component/s: Documentation
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      Clarify the intent and read preference used by the MongoCollection.runCommand methods.

      Where the commands are run are based on if a read preference is supplied:

      method read preference use case
      runCommand(Bson command) primary run write commands.
      eg. create index, create collection, drop collection etc..
      runCommand(Bson command, ReadPreference readPreference) as supplied run any commands with the supplied readPreference.
      eg dbstats, profile, ismaster etc..

      Add examples to the quick-tour-admin.md, needs to be done in async also.

            Assignee:
            Ross Lawley
            Reporter:
            Ross Lawley
            None
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: