Uploaded image for project: 'Couchbase Documentation'
  1. Couchbase Documentation
  2. DOC-7329

cbimport JSON/CSV -generate-key flag is in the optional section

    XMLWordPrintable

Details

    • Bug
    • Status: Closed
    • Minor
    • Resolution: Won't Fix
    • 6.6.0
    • None
    • tools
    • 1

    Description

      Problem

      -generate-key flag is a required flag when using list and line format. It is current under the Optional flag list in the docs

      Expectation 

      For the -generate-key flag to be in the required section and not in the Optional section in the docs

      Notes

      On first glance it appears to be optional, but actually required for list/lines format which is the main use case.

      Attachments

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            owend Daniel Owen added a comment -

            Hey Carlos Gonzalez Betancort Would you mind taking a look at this?

            owend Daniel Owen added a comment - Hey Carlos Gonzalez Betancort Would you mind taking a look at this?

            Patrick Varley Daniel Owen Hitesh Walia The reason why this appears under optional is that it is technically optional as it is not required with the sample format. I can move it in the docs to the Required group if we are happy to ignore the sample format.

            This is even highlighted in the help message which says:

            This parameter is required for list and lines formats, but not for the sample format

            carlos.gonzalez Carlos Gonzalez Betancort (Inactive) added a comment - - edited Patrick Varley Daniel Owen Hitesh Walia The reason why this appears under optional is that it is technically optional as it is not required with the sample format. I can move it in the docs to the Required group if we are happy to ignore the sample format. This is even highlighted in the help message which says: This parameter is required for list and lines formats, but not for the sample format
            owend Daniel Owen added a comment -

            I think it ls best if we move into the required - to avoid the confusion.

            owend Daniel Owen added a comment - I think it ls best if we move into the required - to avoid the confusion.
            james.lee James Lee added a comment -

            Marking as won't fix, we're stuck between a rock and a hard place... Either:

            1) We mark it as required (which is then wrong for sample importing)
            2) We mark it as optional (which is then wrong for lines/list importing)

            Given that we:
            1) Document that it's required for lines/list format
            2) Return an error to the user clearly indicating that it's required when not supplied

            I think we're already handling this sensibly i.e. whatever way we do it, someone will disagree.

            I'd say the real issue here, is probably that we lump lines/list and sample format into a single man page (which is valid) but means the documentation has to be slightly broader (ideally, we probably shouldn't have documented the sample importer in the first place).

            Daniel Owen please let me know if you disagree with the above.

            james.lee James Lee added a comment - Marking as won't fix, we're stuck between a rock and a hard place... Either: 1) We mark it as required (which is then wrong for sample importing) 2) We mark it as optional (which is then wrong for lines/list importing) Given that we: 1) Document that it's required for lines/list format 2) Return an error to the user clearly indicating that it's required when not supplied I think we're already handling this sensibly i.e. whatever way we do it, someone will disagree. I'd say the real issue here, is probably that we lump lines/list and sample format into a single man page (which is valid) but means the documentation has to be slightly broader (ideally, we probably shouldn't have documented the sample importer in the first place). Daniel Owen please let me know if you disagree with the above.
            owend Daniel Owen added a comment -

            Hi James Lee I'm fine for it to be resolved as won't fix.

            owend Daniel Owen added a comment - Hi James Lee I'm fine for it to be resolved as won't fix.

            People

              owend Daniel Owen
              hitesh.walia Hitesh Walia
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty