[SERVER-11224] listCommands outdated help for aggregate command Created: 16/Oct/13  Updated: 11/Jul/16  Resolved: 21/Oct/13

Status: Closed
Project: Core Server
Component/s: Aggregation Framework
Affects Version/s: 2.5.3
Fix Version/s: 2.5.4

Type: Bug Priority: Trivial - P5
Reporter: Hannes Magnusson Assignee: Mathias Stearn
Resolution: Done Votes: 0
Labels: 26qa
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Gantt Dependency
Backwards Compatibility: Fully Compatible
Operating System: ALL
Participants:

 Description   

..
		},
		"aggregate" : {
			"help" : "{ pipeline : [ { <data-pipe-op>: {...}}, ... ] }",
			"lockType" : 0,
			"slaveOk" : false,
			"adminOnly" : false,
			"slaveOverrideOk" : true
		},
..

I would have expected that it included a "cursor: true", indicating it could either return a cursor or a document.
This would be inline with the other fieldnames in there, detonating "special behavior".

The help is also missing the option argument (i.e. cursor: ...)



 Comments   
Comment by Mathias Stearn [ 21/Oct/13 ]

All links from server to web are supposed to use dochub to allow us to redirect them. If any don't, that is a bug.

Comment by Hannes Magnusson [ 21/Oct/13 ]

Should it not link to http://docs.mongodb.org/manual/aggregation/ rather then "dochub" ?

I'll also have to admit I was hoping for a dedicated "can return cursor" top-level field (like "slaveOkay" and those friends are).

Comment by auto [ 21/Oct/13 ]

Author:

{u'username': u'RedBeard0531', u'name': u'Mathias Stearn', u'email': u'mathias@10gen.com'}

Message: SERVER-11224 Update help for aggregate command
Branch: master
https://github.com/mongodb/mongo/commit/7fb5aa479b0801c1c3de9389e0016a4442a9deae

Comment by Daniel Pasette (Inactive) [ 17/Oct/13 ]

this is already fixed for db.<col>.help()

> db.f.help()
DBCollection help
  ....
 	db.f.aggregate( [pipeline], <optional params> ) - performs an aggregation on a collection; returns a cursor
   ....
>

Generated at Thu Feb 08 03:25:14 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.