Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-10020

Docs for SERVER-28128: Add support for a "comment" parameter to the aggregate command

    XMLWordPrintable

Details

    • Task
    • Status: Closed
    • Major - P3
    • Resolution: Fixed
    • None
    • mongodb-3.6, 3.5.5
    • Server
    • None

    Description

      Documentation Request Summary:

      Hopefully the necessary changes are clear from the ticket description: the aggregate command now accepts an optional string "comment" parameter, similar to the existing comment parameter of the find command, which the user can set to an arbitrary string value to help trace the operation through the profiler, currentOp and logs. Please feel free to ask me if any further details are needed.

      Engineering Ticket Description:

      In order to help users trace output in the logs, the system.profile collection, and db.currentOp() back to their application behavior, we should extend the aggregation command to accept a comment parameter:

      db.runCommand({aggregate: "myCollection", pipeline: [{$match: "foo"}], comment: "fooMatch"});
      

      We should require at command parsing time that the comment is a string. Its diagnostic display in the logs/profile/currentOp should be consistent with that for the find command's comment parameter, documented here.

      Attachments

        Issue Links

          Activity

            People

              pavithra.vetriselvan@mongodb.com Pavithra Vetriselvan
              emily.hall Emily Hall
              Kay Kim Kay Kim (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:
                4 years, 41 weeks, 3 days ago