[CDRIVER-1930] Document semi-public mongoc_bulk_operation_t functions Created: 19/Nov/16  Updated: 25/Jan/18  Resolved: 25/Jan/18

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

Type: New Feature Priority: Major - P3
Reporter: David Golden Assignee: A. Jesse Jiryu Davis
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to CDRIVER-1984 Document mongoc_bulk_operation_new Closed

 Description   

There are several functions that are part of the API for HLL wrappers to use, but that are not documented. It would be helpful for these to be documented at least in the source code.



 Comments   
Comment by Githook User [ 25/Jan/18 ]

Author:

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

Message: CDRIVER-1930 undocument some bulk-op functions

Encourage users to create a fully-configured bulk operation with
mongoc_collection_create_bulk_operation, instead of creating a partly
configured one with mongoc_bulk_operation_new and setting various
fields on it.
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/53567fd51d26ba28a665d37cd3a6d98a5f89b4e0

Comment by Githook User [ 11/Dec/17 ]

Author:

{'name': 'Jeremy Mikola', 'email': 'jmikola@gmail.com', 'username': 'jmikola'}

Message: CDRIVER-1930 docs for client and client_session bulk setters
Branch: r1.9
https://github.com/mongodb/mongo-c-driver/commit/c34de1ed93a71d18a895b02decdefe7b66774e04

Comment by Githook User [ 11/Dec/17 ]

Author:

{'name': 'Jeremy Mikola', 'email': 'jmikola@gmail.com', 'username': 'jmikola'}

Message: CDRIVER-1930 docs for client and client_session bulk setters
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/557b31a5f419cf62854fcf1eff7b5279475bc7e7

Comment by David Golden [ 23/Nov/16 ]

We use the following symbols:

  • mongoc_bulk_operation_destroy
  • mongoc_bulk_operation_execute
  • mongoc_bulk_operation_get_write_concern
  • mongoc_bulk_operation_insert
  • mongoc_bulk_operation_new
  • mongoc_bulk_operation_remove_many_with_opts
  • mongoc_bulk_operation_remove_one_with_opts
  • mongoc_bulk_operation_replace_one_with_opts
  • mongoc_bulk_operation_set_bypass_document_validation
  • mongoc_bulk_operation_set_client
  • mongoc_bulk_operation_set_collection
  • mongoc_bulk_operation_set_database
  • mongoc_bulk_operation_set_write_concern
  • mongoc_bulk_operation_update_many_with_opts
  • mongoc_bulk_operation_update_one_with_opts

At least mongoc_bulk_operation_new is undocumented and you can cross reference the rest from that list.

If you want to check other symbols outside bulk, the list of symbols is in the repo. (Just mentally append "mongoc_" to them.)

Comment by Hannes Magnusson [ 21/Nov/16 ]

Crap! All of those functions should definitely be documented, sorry!
I recently filed a ticket for all (that I saw) exported libbson functions that didn't have docs yet, but didn't check mongoc the time: https://jira.mongodb.org/browse/CDRIVER-1497
Could you please tell us which exact functions you noticed are undocumented and we should prioritize?
It would help us focus on needed areas that need improvements.

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