-
Type: Task
-
Resolution: Fixed
-
Priority: Major - P3
-
Affects Version/s: None
-
Labels:None
Description
Description:
No documentation summary in engineering ticket
Engineering Ticket Description:
When running `mongoexport --help`, I've noticed some of the options are not consistent.
{{uri options:
--uri=mongodb-uri mongodb uri connection string}}Website documents shows that no "=" is needed with the `--uri` option. See https://docs.mongodb.com/manual/reference/program/mongoexport/#cmdoption-mongoexport-uri
{{output options:
-f, --fields=<field>[,<field>]* comma separated list of field names (required for exporting CSV) e.g. -f "name,age"
--fieldFile=<filename> file with field names - 1 per line
--type=<type> the output format, either json or csv (defaults to 'json') (default: json)}}The `--type` option has both "(defaults to 'json')" and "(default: json)".
{{querying options:
-q, --query=<json> query filter, as a JSON string, e.g., '{x:{$gt:1}}'
--queryFile=<filename> path to a file containing a query filter (JSON)
-k, --slaveOk allow secondary reads if available (default true) (default: false)}}The `-k` option shows that the default is both true and false.
Scope of changes
master branch
binary | Status | Commit |
---|---|---|
bsondump.txt | https://github.com/mongodb/docs/commit/2eb083c35a3cb04a60fae5159e97d534e42d33fe | |
mongoimport.txt | https://github.com/mongodb/docs/commit/bc2075a105228a2daf5074b12b4df0c50daf6470 | |
mongotop.txt | https://github.com/mongodb/docs/commit/1879b9a2f3073b715f60d5c6173fb5bd264c7ba4 | |
mongodump.txt | multiple | |
mongoldap.txt | https://github.com/mongodb/docs/commit/29756c4e239387e25afa43c60d1bb3c780fa9799 | |
mongoexport.txt | https://github.com/mongodb/docs/commit/9a081953b455a19ca4f994aed8fb7e9a707aa0f5 | |
mongoreplay.txt | commit Additional work to do with separate ticket: This page needs significant rewrite (poorly worded sentences) |
|
mongosniff.txt | N/A | Removed in 3.4 – Consider removing page for good |
mongofiles.txt | https://github.com/mongodb/docs/commit/b322c3a89c9a3f5eebd86fc551c8207c8a263e05 | |
mongorestore.txt | https://github.com/mongodb/docs/commit/1a95829657bd46fcca99c69b079c75df302151c5 | |
mongostat.txt | https://github.com/mongodb/docs/commit/b1296d7883832eca327a87e63b966fd0c16488e4 |
earlier versions
For earlier versions, for now, just remove the options files.
Impact to Other Docs
MVP (Work and Date)
Resources (Scope or Design Docs, Invision, etc.)
- documents
-
TOOLS-2001 mongoexport command line help not consistent
- Closed
- is related to
-
DOCS-13221 Expected boolean switch but found string
- Closed