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

    • Type: Task
    • Status: Closed
    • Priority: Major - P3
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: mongodb-3.6, 3.5.5
    • Component/s: Server
    • Labels:
      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

              Assignee:
              pavithra.vetriselvan Pavithra Vetriselvan
              Reporter:
              emily.hall Emily Hall
              Participants:
              Last commenter:
              Kay Kim Kay Kim (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                Days since reply:
                3 years, 45 weeks, 4 days ago
                Date of 1st Reply: