Uploaded image for project: 'WiredTiger'
  1. WiredTiger
  2. WT-12163

Improve documentation of state after an error during connection open

    • Type: Icon: Documentation Documentation
    • Resolution: Unresolved
    • Priority: Icon: Major - P3 Major - P3
    • None
    • Affects Version/s: None
    • Component/s: None
    • Labels:
    • StorEng - Defined Pipeline

      When a user first attempts to open a database via wiredtiger_open, the documentation isn't clear on whether the application gets a valid handle that needs to be cleaned up or not.

      We should clarify the expectations: which are that no cleanup is necessary, since a call to wiredtiger_open that returns an error will call __wt_connection_close prior to returning to the user - which will release resources.

      The documentation I'm referring to is here, and currently says:

      zero on success and a non-zero error code on failure. See Error handling for details.

      It should be extended to clarify that the returned handle isn't valid for further use, and no explicit cleanup is required. Note that the error text is generated from here, and is shared by a lot of APIs at the moment. It will need some careful extension to customize it, but allow it to share the primary text.

            Assignee:
            backlog-server-storage-engines [DO NOT USE] Backlog - Storage Engines Team
            Reporter:
            alexander.gorrod@mongodb.com Alexander Gorrod
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated: