[CDRIVER-2679] Finish documenting "with_opts" functions Created: 02/Jun/18  Updated: 28/Oct/23  Resolved: 24/Jul/18

Status: Closed
Project: C Driver
Component/s: docs, libmongoc
Affects Version/s: None
Fix Version/s: 1.13.0

Type: Improvement Priority: Minor - P4
Reporter: A. Jesse Jiryu Davis Assignee: A. Jesse Jiryu Davis
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Problem/Incident
is caused by CDRIVER-1526 Rename "_with_write_concern" function... Closed

 Description   

The following functions take "opts" and have no documentation about what "opts" are accepted:

  • mongoc_client_find_databases_with_opts
  • mongoc_client_get_database_names_with_opts
  • mongoc_collection_find_indexes_with_opts
  • mongoc_database_find_collections_with_opts
  • mongoc_database_get_collection_names_with_opts

Document common fields that the C Driver parses from these functions' opts. The most important is sessionId, which permits some of these functions to be used in a transaction, and some of them to participate in causal consistency . Do not document fields that the server parses from opts, that documentation is in the MongoDB Manual only.



 Comments   
Comment by Githook User [ 24/Jul/18 ]

Author:

{'name': 'A. Jesse Jiryu Davis', 'email': 'jesse@mongodb.com', 'username': 'ajdavis'}

Message: CDRIVER-2679 document remaining with_opts funcs
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/edcdf0c256fdf73a9ebf031bb656a8e4f8a171e8

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