HBASE-3539 Improve shell help to reflect all possible options

git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@1096533 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Stack 2011-04-25 17:34:24 +00:00
parent b91fb30a82
commit e448a81053
3 changed files with 12 additions and 6 deletions

View File

@ -84,6 +84,8 @@ Release 0.91.0 - Unreleased
HBASE-3800 HMaster is not able to start due to AlreadyCreatedException HBASE-3800 HMaster is not able to start due to AlreadyCreatedException
HBASE-3806 distributed log splitting double escapes task names HBASE-3806 distributed log splitting double escapes task names
(Prakash Khemani) (Prakash Khemani)
HBASE-3539 Improve shell help to reflect all possible options
(Harsh J Chouraria)
IMPROVEMENTS IMPROVEMENTS
HBASE-3290 Max Compaction Size (Nicolas Spiegelberg via Stack) HBASE-3290 Max Compaction Size (Nicolas Spiegelberg via Stack)

View File

@ -24,7 +24,7 @@ module Shell
def help def help
return <<-EOF return <<-EOF
Get row or cell contents; pass table name, row, and optionally Get row or cell contents; pass table name, row, and optionally
a dictionary of column(s), timestamp and versions. Examples: a dictionary of column(s), timestamp, timerange and versions. Examples:
hbase> get 't1', 'r1' hbase> get 't1', 'r1'
hbase> get 't1', 'r1', {TIMERANGE => [ts1, ts2]} hbase> get 't1', 'r1', {TIMERANGE => [ts1, ts2]}

View File

@ -24,15 +24,19 @@ module Shell
def help def help
return <<-EOF return <<-EOF
Scan a table; pass table name and optionally a dictionary of scanner Scan a table; pass table name and optionally a dictionary of scanner
specifications. Scanner specifications may include one or more of specifications. Scanner specifications may include one or more of:
the following: LIMIT, STARTROW, STOPROW, TIMESTAMP, or COLUMNS. If TIMERANGE, FILTER, LIMIT, STARTROW, STOPROW, TIMESTAMP, MAXLENGTH,
no columns are specified, all columns will be scanned. To scan all or COLUMNS. If no columns are specified, all columns will be scanned.
members of a column family, leave the qualifier empty as in To scan all members of a column family, leave the qualifier empty as in
'col_family:'. Examples: 'col_family:'.
Some examples:
hbase> scan '.META.' hbase> scan '.META.'
hbase> scan '.META.', {COLUMNS => 'info:regioninfo'} hbase> scan '.META.', {COLUMNS => 'info:regioninfo'}
hbase> scan 't1', {COLUMNS => ['c1', 'c2'], LIMIT => 10, STARTROW => 'xyz'} hbase> scan 't1', {COLUMNS => ['c1', 'c2'], LIMIT => 10, STARTROW => 'xyz'}
hbase> scan 't1', {FILTER => org.apache.hadoop.hbase.filter.ColumnPaginationFilter.new(1, 0)}
hbase> scan 't1', {COLUMNS => 'c1', TIMERANGE => [1303668804, 1303668904]}
For experts, there is an additional option -- CACHE_BLOCKS -- which For experts, there is an additional option -- CACHE_BLOCKS -- which
switches block caching for the scanner on (true) or off (false). By switches block caching for the scanner on (true) or off (false). By