[CDRIVER-1549] Connection string documentation incomplete Created: 19/Sep/16  Updated: 03/May/17  Resolved: 16/Mar/17

Status: Closed
Project: C Driver
Component/s: docs
Affects Version/s: None
Fix Version/s: 1.7.0

Type: Improvement Priority: Major - P3
Reporter: David Golden Assignee: Hannes Magnusson
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Epic Link: C Driver Connection String Spec

 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.



 Comments   
Comment by Githook User [ 16/Mar/17 ]

Author:

{u'username': u'bjori', u'name': u'Hannes Magnusson', u'email': u'bjori@php.net'}

Message: CDRIVER-1549 Connection string documentation incomplete
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/63a68090e928d2e8867e90a8a943f7addfb83e61

Generated at Wed Feb 07 21:12:52 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.