[DOCS-10020] Docs for SERVER-28128: Add support for a "comment" parameter to the aggregate command Created: 22/Mar/17  Updated: 30/Nov/17  Resolved: 17/Oct/17

Status: Closed
Project: Documentation
Component/s: Server
Affects Version/s: None
Fix Version/s: mongodb-3.6, 3.5.5

Type: Task Priority: Major - P3
Reporter: Emily Hall Assignee: Pavithra Vetriselvan
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-28128 Add support for a "comment" parameter... Closed
Participants:
Days since reply: 6 years, 21 weeks, 2 days ago
Epic Link: DOCS: 3.6 Server

 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.



 Comments   
Comment by Githook User [ 19/Sep/17 ]

Author:

{'name': 'Pavithra Vetriselvan', 'email': 'pavi@MacBook-Pro-77.local'}

Message: DOCS-10020 added comment param documentation to db.col.aggregate() and aggregate
Branch: master
https://github.com/mongodb/docs/commit/1b323036025016a35859c5b71c00d17f24a99e55

Generated at Thu Feb 08 07:59:38 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.