org.apache.hadoop.hbase.regionserver

Class InternalScan

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

org.apache.hadoop.hbase.regionserver.InternalScan

All Implemented Interfaces:

Attributes

@InterfaceAudience.LimitedPrivate(value="Coprocesssor")
public class InternalScan
extends Scan

Special scanner, currently used for increment operations to allow additional server-side arguments for Scan operations.

Rather than adding new options/parameters to the public Scan API, this new class has been created.

Supports adding an option to only read from the MemStore with checkOnlyMemStore() or to only read from StoreFiles with checkOnlyStoreFiles().

Nested Class Summary

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

Scan.ReadType

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	filesOnly
private boolean	memOnly

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

DEFAULT_HBASE_CLIENT_SCANNER_ASYNC_PREFETCH, HBASE_CLIENT_SCANNER_ASYNC_PREFETCH, 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
InternalScan(Get get)
InternalScan(Scan scan)

Method Summary

Modifier and Type	Method and Description
void	checkOnlyMemStore() StoreFiles will not be scanned.
void	checkOnlyStoreFiles() MemStore will not be scanned.
boolean	isCheckOnlyMemStore() Returns true if only the MemStore should be checked.
boolean	isCheckOnlyStoreFiles() Returns true if only StoreFiles should be checked.

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, isAsyncPrefetch, isGetScan, isNeedCursorResult, isRaw, isReversed, isScanMetricsEnabled, isSmall, numFamilies, readAllVersions, readVersions, setACL, setACL, setAllowPartialResults, setAsyncPrefetch, 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, setRowPrefixFilter, setScanMetricsEnabled, setSmall, setStartRow, setStartStopRowForPrefixScan, setStopRow, setTimeRange, setTimestamp, 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

Field Detail

memOnly

private boolean memOnly

filesOnly

private boolean filesOnly

Constructor Detail

InternalScan

public InternalScan(Get get)

Parameters:

get - get to model scan after

InternalScan

public InternalScan(Scan scan)
             throws IOException

Parameters:

scan - - original scan object n

Throws:

IOException

Method Detail

checkOnlyMemStore

public void checkOnlyMemStore()

StoreFiles will not be scanned. Only MemStore will be scanned.

checkOnlyStoreFiles

public void checkOnlyStoreFiles()

MemStore will not be scanned. Only StoreFiles will be scanned.

isCheckOnlyMemStore

public boolean isCheckOnlyMemStore()

Returns true if only the MemStore should be checked. False if not.

Returns:

true to only check MemStore

isCheckOnlyStoreFiles

public boolean isCheckOnlyStoreFiles()

Returns true if only StoreFiles should be checked. False if not.

Returns:

true if only check StoreFiles