| Package | +Description | +
|---|---|
| org.apache.hadoop.hbase | ++ |
| org.apache.hadoop.hbase.client | +
+ Provides HBase Client
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
CellScanner |
+CellScannable.cellScanner() |
+
static CellScanner |
+CellUtil.createCellScanner(Cell[] cellArray) |
+
static CellScanner |
+CellUtil.createCellScanner(Iterable<Cell> cellIterable) |
+
static CellScanner |
+CellUtil.createCellScanner(Iterator<Cell> cells) |
+
static CellScanner |
+CellUtil.createCellScanner(List<? extends CellScannable> cellScannerables) |
+
static CellScanner |
+CellUtil.createCellScanner(NavigableMap<byte[],List<Cell>> map)
+Flatten the map of cells out under the CellScanner
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+Result
+
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
CellScanner |
+Result.cellScanner() |
+
CellScanner |
+Mutation.cellScanner() |
+
Copyright © 2007–2017 The Apache Software Foundation. All rights reserved.
+ + http://git-wip-us.apache.org/repos/asf/hbase-site/blob/c54c242b/apidocs/org/apache/hadoop/hbase/client/Append.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/Append.html b/apidocs/org/apache/hadoop/hbase/client/Append.html index 24af617..14799fe 100644 --- a/apidocs/org/apache/hadoop/hbase/client/Append.html +++ b/apidocs/org/apache/hadoop/hbase/client/Append.html @@ -124,7 +124,7 @@ var activeTableTab = "activeTableTab";@InterfaceAudience.Public public abstract class Mutation extends OperationWithAttributes -implements Row, org.apache.hadoop.hbase.CellScannable, org.apache.hadoop.hbase.io.HeapSize+implements Row, CellScannable, org.apache.hadoop.hbase.io.HeapSize
org.apache.hadoop.hbase.CellScannerCellScannercellScanner() public org.apache.hadoop.hbase.CellScanner cellScanner()+
public CellScanner cellScanner()
cellScanner in interface org.apache.hadoop.hbase.CellScannablecellScanner in interface CellScannableCells@InterfaceAudience.Public public class Result extends Object -implements org.apache.hadoop.hbase.CellScannable, org.apache.hadoop.hbase.CellScanner+implements CellScannable, CellScanner
Get or Scan query.This class is NOT THREAD SAFE.
@@ -141,10 +141,10 @@ implements org.apache.hadoop.hbase.CellScannable, org.apache.hadoop.hbase.CellSc
The underlying Cell objects can be accessed through the method listCells().
This will create a List from the internal Cell []. Better is to exploit the fact that
- a new Result instance is a primed CellScanner; just call advance() and
- current() to iterate over Cells as you would any CellScanner.
+ a new Result instance is a primed CellScanner; just call advance() and
+ current() to iterate over Cells as you would any CellScanner.
Call cellScanner() to reset should you need to iterate the same Result over again
- (CellScanners are one-shot).
+ (CellScanners are one-shot).
If you need to overwrite a Result with another Result instance -- as in the old 'mapred'
RecordReader next invocations -- then create an empty Result with the null constructor and
@@ -230,7 +230,7 @@ implements org.apache.hadoop.hbase.CellScannable, org.apache.hadoop.hbase.CellSc
org.apache.hadoop.hbase.CellScannerCellScannercellScanner() public org.apache.hadoop.hbase.CellScanner cellScanner()+
public CellScanner cellScanner()
cellScanner in interface org.apache.hadoop.hbase.CellScannablecellScanner in interface CellScannableCellspublic Cell current()
current in interface org.apache.hadoop.hbase.CellScannercurrent in interface CellScannerpublic boolean advance()-
org.apache.hadoop.hbase.CellScannerCellScanneradvance in interface org.apache.hadoop.hbase.CellScanneradvance in interface CellScannerCellScanner.current() will return a valid CellCellScanner.current() will return a valid CellFilterList.
If an already known row range needs to be scanned,
- use CellScanner start
+ use CellScanner start
and stop rows directly rather than a filter.
You must also specify a family and qualifier. Only the value of this column
will be tested. When using this filter on a
- CellScanner with specified
+ CellScanner with specified
inputs, the column to be tested should also be added as input (otherwise
the filter will regard the column as missing).
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/c54c242b/apidocs/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormat.html
----------------------------------------------------------------------
diff --git a/apidocs/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormat.html b/apidocs/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormat.html
index 23cfdc2..96bada2 100644
--- a/apidocs/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormat.html
+++ b/apidocs/org/apache/hadoop/hbase/mapreduce/TableSnapshotInputFormat.html
@@ -147,7 +147,7 @@ extends org.apache.hadoop.mapreduce.InputFormat<CellScanner obtained from the user.
HBase owns all the data and snapshot files on the filesystem. Only the 'hbase' user can read from snapshot files and data files. http://git-wip-us.apache.org/repos/asf/hbase-site/blob/c54c242b/apidocs/org/apache/hadoop/hbase/package-frame.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/package-frame.html b/apidocs/org/apache/hadoop/hbase/package-frame.html index 7927481..4a35722 100644 --- a/apidocs/org/apache/hadoop/hbase/package-frame.html +++ b/apidocs/org/apache/hadoop/hbase/package-frame.html @@ -16,6 +16,8 @@
001/** +002 * Licensed to the Apache Software Foundation (ASF) under one +003 * or more contributor license agreements. See the NOTICE file +004 * distributed with this work for additional information +005 * regarding copyright ownership. The ASF licenses this file +006 * to you under the Apache License, Version 2.0 (the +007 * "License"); you may not use this file except in compliance +008 * with the License. You may obtain a copy of the License at +009 * +010 * http://www.apache.org/licenses/LICENSE-2.0 +011 * +012 * Unless required by applicable law or agreed to in writing, software +013 * distributed under the License is distributed on an "AS IS" BASIS, +014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +015 * See the License for the specific language governing permissions and +016 * limitations under the License. +017 */ +018package org.apache.hadoop.hbase; +019 +020import org.apache.yetus.audience.InterfaceAudience; +021 +022/** +023 * Implementer can return a CellScanner over its Cell content. +024 * Class name is ugly but mimicing java.util.Iterable only we are about the dumber +025 * CellScanner rather than say Iterator<Cell>. See CellScanner class comment for why we go +026 * dumber than java.util.Iterator. +027 */ +028@InterfaceAudience.Public +029public interface CellScannable { +030 /** +031 * @return A CellScanner over the contained {@link Cell}s +032 */ +033 CellScanner cellScanner(); +034} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ++
001/** +002 * Licensed to the Apache Software Foundation (ASF) under one +003 * or more contributor license agreements. See the NOTICE file +004 * distributed with this work for additional information +005 * regarding copyright ownership. The ASF licenses this file +006 * to you under the Apache License, Version 2.0 (the +007 * "License"); you may not use this file except in compliance +008 * with the License. You may obtain a copy of the License at +009 * +010 * http://www.apache.org/licenses/LICENSE-2.0 +011 * +012 * Unless required by applicable law or agreed to in writing, software +013 * distributed under the License is distributed on an "AS IS" BASIS, +014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +015 * See the License for the specific language governing permissions and +016 * limitations under the License. +017 */ +018 +019package org.apache.hadoop.hbase; +020 +021import java.io.IOException; +022 +023import org.apache.yetus.audience.InterfaceAudience; +024import org.apache.yetus.audience.InterfaceStability; +025 +026/** +027 * An interface for iterating through a sequence of cells. Similar to Java's Iterator, but without +028 * the hasNext() or remove() methods. The hasNext() method is problematic because it may require +029 * actually loading the next object, which in turn requires storing the previous object somewhere. +030 * +031 * <p>The core data block decoder should be as fast as possible, so we push the complexity and +032 * performance expense of concurrently tracking multiple cells to layers above the CellScanner. +033 * <p> +034 * The {@link #current()} method will return a reference to a Cell implementation. This reference +035 * may or may not point to a reusable cell implementation, so users of the CellScanner should not, +036 * for example, accumulate a List of Cells. All of the references may point to the same object, +037 * which would be the latest state of the underlying Cell. In short, the Cell is mutable. +038 * </p> +039 * Typical usage: +040 * +041 * <pre> +042 * while (scanner.advance()) { +043 * Cell cell = scanner.current(); +044 * // do something +045 * } +046 * </pre> +047 * <p>Often used reading {@link org.apache.hadoop.hbase.Cell}s written by +048 * {@link org.apache.hadoop.hbase.io.CellOutputStream}. +049 */ +050@InterfaceAudience.Public +051public interface CellScanner { +052 /** +053 * @return the current Cell which may be mutable +054 */ +055 Cell current(); +056 +057 /** +058 * Advance the scanner 1 cell. +059 * @return true if the next cell is found and {@link #current()} will return a valid Cell +060 * @throws IOException +061 */ +062 boolean advance() throws IOException; +063} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ++