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

Docs for TOOLS-2001: mongoexport command line help not consistent

    XMLWordPrintableJSON

Details

    Description

      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

      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.)

      Attachments

        Activity

          People

            kay.kim@mongodb.com Kay Kim (Inactive)
            kay.kim@mongodb.com Kay Kim (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              4 years, 2 weeks, 2 days ago