com.google.cloud.bigtable.hbase

Class BigtableExtendedScan

java.lang.Object

org.apache.hadoop.hbase.client.Operation

org.apache.hadoop.hbase.client.OperationWithAttributes

org.apache.hadoop.hbase.client.Query

org.apache.hadoop.hbase.client.Scan

com.google.cloud.bigtable.hbase.BigtableExtendedScan

All Implemented Interfaces:

org.apache.hadoop.hbase.client.Attributes

@InternalExtensionOnly
public class BigtableExtendedScan
extends org.apache.hadoop.hbase.client.Scan

This is a Cloud Bigtable specific extension of Scan. The Cloud Bigtable ReadRows API allows for an arbitrary set of ranges and row keys as part of a scan. Instance of BigtableExtendedScan can be used in Table.getScanner(Scan).

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.client.Scan

org.apache.hadoop.hbase.client.Scan.ReadType

Field Summary

Fields inherited from class org.apache.hadoop.hbase.client.Scan

HINT_LOOKAHEAD, SCAN_ATTRIBUTES_METRICS_DATA, SCAN_ATTRIBUTES_METRICS_ENABLE, SCAN_ATTRIBUTES_TABLE_NAME

Fields inherited from class org.apache.hadoop.hbase.client.Query

colFamTimeRangeMap, consistency, filter, loadColumnFamiliesOnDemand, targetReplicaId

Fields inherited from class org.apache.hadoop.hbase.client.OperationWithAttributes

ID_ATRIBUTE

Constructor Summary

Constructors

Constructor and Description
BigtableExtendedScan()

Method Summary

Modifier and Type	Method and Description
void	addRange(byte[] startRow, byte[] stopRow) Adds a range to scan.
void	addRange(com.google.bigtable.v2.RowRange range) Adds an arbitrary RowRange to the request.
void	addRangeWithPrefix(byte[] prefix) Creates a RowRange based on a prefix.
void	addRowKey(byte[] rowKey) Add a single row key to the output.
com.google.bigtable.v2.RowSet	getRowSet()
org.apache.hadoop.hbase.client.Scan	setRowPrefixFilter(byte[] rowPrefix)
org.apache.hadoop.hbase.client.Scan	setStartRow(byte[] startRow)
org.apache.hadoop.hbase.client.Scan	setStopRow(byte[] stopRow)

Methods inherited from class org.apache.hadoop.hbase.client.Scan

addColumn, addFamily, createScanFromCursor, getAllowPartialResults, getBatch, getCacheBlocks, getCaching, getFamilies, getFamilyMap, getFilter, getFingerprint, getLimit, getMaxResultSize, getMaxResultsPerColumnFamily, getMaxVersions, getReadType, getRowOffsetPerColumnFamily, getScanMetrics, getStartRow, getStopRow, getTimeRange, hasFamilies, hasFilter, includeStartRow, includeStopRow, isGetScan, isNeedCursorResult, isRaw, isReversed, isScanMetricsEnabled, isSmall, numFamilies, setACL, setACL, setAllowPartialResults, setAttribute, setAuthorizations, setBatch, setCacheBlocks, setCaching, setColumnFamilyTimeRange, setConsistency, setFamilyMap, setFilter, setId, setIsolationLevel, setLimit, setLoadColumnFamiliesOnDemand, setMaxResultSize, setMaxResultsPerColumnFamily, setMaxVersions, setMaxVersions, setNeedCursorResult, setOneRowLimit, setPriority, setRaw, setReadType, setReplicaId, setReversed, setRowOffsetPerColumnFamily, setScanMetricsEnabled, setSmall, setTimeRange, setTimeStamp, toMap, withStartRow, withStartRow, withStopRow, withStopRow

Methods inherited from class org.apache.hadoop.hbase.client.Query

doLoadColumnFamiliesOnDemand, getACL, getAuthorizations, getColumnFamilyTimeRange, getConsistency, getIsolationLevel, getLoadColumnFamiliesOnDemandValue, getReplicaId

Methods inherited from class org.apache.hadoop.hbase.client.OperationWithAttributes

getAttribute, getAttributeSize, getAttributesMap, getId, getPriority

Methods inherited from class org.apache.hadoop.hbase.client.Operation

toJSON, toJSON, toMap, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BigtableExtendedScan

public BigtableExtendedScan()

Method Detail

setStartRow

public org.apache.hadoop.hbase.client.Scan setStartRow(byte[] startRow)

Overrides:

setStartRow in class org.apache.hadoop.hbase.client.Scan

Throws:

UnsupportedOperationException - to avoid confusion. Use addRange(byte[], byte[]) instead.

setStopRow

public org.apache.hadoop.hbase.client.Scan setStopRow(byte[] stopRow)

Overrides:

setStopRow in class org.apache.hadoop.hbase.client.Scan

Throws:

UnsupportedOperationException - to avoid confusion. Use addRange(byte[], byte[]) instead.

setRowPrefixFilter

public org.apache.hadoop.hbase.client.Scan setRowPrefixFilter(byte[] rowPrefix)

Overrides:

setRowPrefixFilter in class org.apache.hadoop.hbase.client.Scan

Throws:

UnsupportedOperationException - to avoid confusion. Use addRangeWithPrefix(byte[]) instead.

addRangeWithPrefix

public void addRangeWithPrefix(byte[] prefix)

Creates a RowRange based on a prefix. This is similar to Scan.setRowPrefixFilter(byte[]).

Parameters:

prefix - a byte array.

addRange

public void addRange(byte[] startRow,
                     byte[] stopRow)

Adds a range to scan. This is similar to calling a combination of Scan.setStartRow(byte[]) and Scan.setStopRow(byte[]). Other ranges can be constructed by creating a RowRange and calling addRange(RowRange)

Parameters:

startRow - a byte array.

stopRow - a byte array.

addRange

public void addRange(com.google.bigtable.v2.RowRange range)

Adds an arbitrary RowRange to the request. Ranges can have empty start keys or end keys. Ranges can also be inclusive/closed or exclusive/open. The default range is inclusive start and exclusive end.

Parameters:

range - a RowRange object.

addRowKey

public void addRowKey(byte[] rowKey)

Add a single row key to the output. This can be called multiple times with random rowKeys. Duplicate rowKeys will result in a single response in the scan results. Results of scans also return rows in lexicographically sorted order, and not based on the order in which row keys were added.

Parameters:

rowKey - a byte array.

getRowSet

public com.google.bigtable.v2.RowSet getRowSet()

Returns:

the RowSet built until now, which includes lists of individual keys and row ranges.