Typedef bulk write types to clearly distinguish between collection and client bulk write

XMLWordPrintableJSON

    • Type: Improvement
    • Resolution: Unresolved
    • Priority: Minor - P4
    • None
    • Affects Version/s: None
    • Component/s: None
    • Not Needed
    • None
    • C Drivers
    • None
    • None
    • None
    • None
    • None
    • None

      Collection bulk write uses the naming scheme mongoc_bulk_operation* while client bulk write uses the naming scheme mongoc_bulkwrite*. This may be confusing to users as these naming schemes do not clearly delineate between the two types of bulk write APIs. Moreover, the C++ analogue of mongoc_bulk_operation_t is bulk_write while mongoc_bulkwrite_t is client_bulk_write, which defies expectations.

      To avoid confusion, we should consider introducing typedefs like the following:

      typedef mongoc_bulkwrite_t mongoc_client_bulkwrite_t
      typedef mongoc_bulk_operation_t mongoc_collection_bulkwrite_t
      

      Additionally, if possible, we could consider deprecating the old names to encourage the use of the new names.

            Assignee:
            Unassigned
            Reporter:
            Connor MacDonald
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: