Uploaded image for project: 'C Driver'
  1. C Driver
  2. CDRIVER-1549

Connection string documentation incomplete

    XMLWordPrintableJSON

Details

    • Icon: Improvement Improvement
    • Resolution: Done
    • Icon: Major - P3 Major - P3
    • 1.7.0
    • None
    • docs
    • None

    Description

      I was trying to find out what connection string options were supported and had a hard time doing so. Some observations:

      • Advanced Connections directs people to the MongoDB manual for information on additional connection options instead of to the mongoc_uri_t page, where most of them are actually documented.
      • On that last page, the "More information links at the bottom are duplicated and direct back to the index – it's sort of circular.
      • mongoc_uri_t docs don't mention authMechanism, but do have a function for it. It appears that none of the auth options in the MongoDB manual are documented in mongoc_uri_t docs.

      Separately, there are "helper" functions for many URI options, but not all. That's potentially confusing and perhaps worth documenting the rationale for why only some options have associated functions.

      Attachments

        Activity

          People

            bjori Hannes Magnusson
            david.golden@mongodb.com David Golden
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: