| # |
| # |
| # Licensed to the Apache Software Foundation (ASF) under one |
| # or more contributor license agreements. See the NOTICE file |
| # distributed with this work for additional information |
| # regarding copyright ownership. The ASF licenses this file |
| # to you under the Apache License, Version 2.0 (the |
| # "License"); you may not use this file except in compliance |
| # with the License. You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| # |
| |
| module Shell |
| module Commands |
| class Get < Command |
| def help |
| return <<-EOF |
| Get row or cell contents; pass table name, row, and optionally |
| a dictionary of column(s), timestamp, timerange and versions. Examples: |
| |
| hbase> get 'ns1:t1', 'r1' |
| hbase> get 't1', 'r1' |
| hbase> get 't1', 'r1', {TIMERANGE => [ts1, ts2]} |
| hbase> get 't1', 'r1', {COLUMN => 'c1'} |
| hbase> get 't1', 'r1', {COLUMN => ['c1', 'c2', 'c3']} |
| hbase> get 't1', 'r1', {COLUMN => 'c1', TIMESTAMP => ts1} |
| hbase> get 't1', 'r1', {COLUMN => 'c1', TIMERANGE => [ts1, ts2], VERSIONS => 4} |
| hbase> get 't1', 'r1', {COLUMN => 'c1', TIMESTAMP => ts1, VERSIONS => 4} |
| hbase> get 't1', 'r1', {FILTER => "ValueFilter(=, 'binary:abc')"} |
| hbase> get 't1', 'r1', 'c1' |
| hbase> get 't1', 'r1', 'c1', 'c2' |
| hbase> get 't1', 'r1', ['c1', 'c2'] |
| hbase> get 't1', 'r1', {COLUMN => 'c1', ATTRIBUTES => {'mykey'=>'myvalue'}} |
| hbase> get 't1', 'r1', {COLUMN => 'c1', AUTHORIZATIONS => ['PRIVATE','SECRET']} |
| hbase> get 't1', 'r1', {CONSISTENCY => 'TIMELINE'} |
| hbase> get 't1', 'r1', {CONSISTENCY => 'TIMELINE', REGION_REPLICA_ID => 1} |
| |
| Besides the default 'toStringBinary' format, 'get' also supports custom formatting by |
| column. A user can define a FORMATTER by adding it to the column name in the get |
| specification. The FORMATTER can be stipulated: |
| |
| 1. either as a org.apache.hadoop.hbase.util.Bytes method name (e.g, toInt, toString) |
| 2. or as a custom class followed by method name: e.g. 'c(MyFormatterClass).format'. |
| |
| Example formatting cf:qualifier1 and cf:qualifier2 both as Integers: |
| hbase> get 't1', 'r1' {COLUMN => ['cf:qualifier1:toInt', |
| 'cf:qualifier2:c(org.apache.hadoop.hbase.util.Bytes).toInt'] } |
| |
| Note that you can specify a FORMATTER by column only (cf:qualifier). You cannot specify |
| a FORMATTER for all columns of a column family. |
| |
| The same commands also can be run on a reference to a table (obtained via get_table or |
| create_table). Suppose you had a reference t to table 't1', the corresponding commands |
| would be: |
| |
| hbase> t.get 'r1' |
| hbase> t.get 'r1', {TIMERANGE => [ts1, ts2]} |
| hbase> t.get 'r1', {COLUMN => 'c1'} |
| hbase> t.get 'r1', {COLUMN => ['c1', 'c2', 'c3']} |
| hbase> t.get 'r1', {COLUMN => 'c1', TIMESTAMP => ts1} |
| hbase> t.get 'r1', {COLUMN => 'c1', TIMERANGE => [ts1, ts2], VERSIONS => 4} |
| hbase> t.get 'r1', {COLUMN => 'c1', TIMESTAMP => ts1, VERSIONS => 4} |
| hbase> t.get 'r1', {FILTER => "ValueFilter(=, 'binary:abc')"} |
| hbase> t.get 'r1', 'c1' |
| hbase> t.get 'r1', 'c1', 'c2' |
| hbase> t.get 'r1', ['c1', 'c2'] |
| hbase> t.get 'r1', {CONSISTENCY => 'TIMELINE'} |
| hbase> t.get 'r1', {CONSISTENCY => 'TIMELINE', REGION_REPLICA_ID => 1} |
| EOF |
| end |
| |
| def command(table, row, *args) |
| get(table(table), row, *args) |
| end |
| |
| def get(table, row, *args) |
| now = Time.now |
| formatter.header(["COLUMN", "CELL"]) |
| |
| table._get_internal(row, *args) do |column, value| |
| formatter.row([ column, value ]) |
| end |
| |
| formatter.footer(now) |
| end |
| end |
| end |
| end |
| |
| #add get command to table |
| ::Hbase::Table.add_shell_command('get') |