HBase
  1. HBase
  2. HBASE-3539

Improve shell help to reflect all possible options

    Details

    • Type: Bug Bug
    • Status: Resolved
    • Priority: Trivial Trivial
    • Resolution: Fixed
    • Affects Version/s: 0.90.0
    • Fix Version/s: 0.90.3
    • Component/s: shell
    • Labels:
      None
    • Hadoop Flags:
      Reviewed

      Description

      The shell is not consistent in its help texts. For example:

      Scan a table; pass table name and optionally a dictionary of scanner
      specifications.  Scanner specifications may include one or more of
      the following: LIMIT, STARTROW, STOPROW, TIMESTAMP, or COLUMNS.  If
      no columns are specified, all columns will be scanned.
      

      but in the code you have

       filter = args["FILTER"]
       startrow = args["STARTROW"] || ''
       stoprow = args["STOPROW"]
       timestamp = args["TIMESTAMP"]
       columns = args["COLUMNS"] || args["COLUMN"] || get_all_columns
       cache = args["CACHE_BLOCKS"] || true
       versions = args["VERSIONS"] || 1
      

      VERSIONS is missing from the help.

      Check all commands and make sure all options are stated and examples given.

        Activity

        Hide
        Harsh J added a comment -

        I looked over at all commands in ruby/shell/commands/*.rb and found only 'scan' to lack what you describe. Added in a minor addition to the 'get' output as well.

        Docs carry a reference to HBASE-2470's patch.

        Show
        Harsh J added a comment - I looked over at all commands in ruby/shell/commands/*.rb and found only 'scan' to lack what you describe. Added in a minor addition to the 'get' output as well. Docs carry a reference to HBASE-2470 's patch.
        Hide
        stack added a comment -

        Applied to TRUNK. Thank you for the patch Harsh (I added you as a contributor and assigned you this issue).

        Show
        stack added a comment - Applied to TRUNK. Thank you for the patch Harsh (I added you as a contributor and assigned you this issue).
        Hide
        stack added a comment -

        Brought issue back on to TRUNK too (Usability).

        Show
        stack added a comment - Brought issue back on to TRUNK too (Usability).

          People

          • Assignee:
            Harsh J
            Reporter:
            Lars George
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development