org.apache.hadoop.hbase.regionserver.querymatcher

Class UserScanQueryMatcher

java.lang.Object

org.apache.hadoop.hbase.regionserver.querymatcher.ScanQueryMatcher

org.apache.hadoop.hbase.regionserver.querymatcher.UserScanQueryMatcher

All Implemented Interfaces:

ShipperListener

Direct Known Subclasses:

NormalUserScanQueryMatcher, RawScanQueryMatcher

@InterfaceAudience.Private
public abstract class UserScanQueryMatcher
extends ScanQueryMatcher

Query matcher for user scan.

We do not consider mvcc here because StoreFileScanner and SegmentScanner will only return a cell whose mvcc is less than or equal to given read point. For IsolationLevel.READ_UNCOMMITTED, we just set the read point to Long.MAX_VALUE, i.e. still do not need to consider it.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.regionserver.querymatcher.ScanQueryMatcher

ScanQueryMatcher.MatchCode

Field Summary

Fields

Modifier and Type	Field and Description
private int	count
private Cell	curColCell
protected Filter	filter
protected boolean	hasNullColumn
protected byte[]	stopRow
protected TimeRange	tr
private int	versionsAfterFilter

Fields inherited from class org.apache.hadoop.hbase.regionserver.querymatcher.ScanQueryMatcher

columns, currentRow, now, oldestUnexpiredTS, rowComparator, startKey

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserScanQueryMatcher(Scan scan, ScanInfo scanInfo, ColumnTracker columns, boolean hasNullColumn, long oldestUnexpiredTS, long now)

Method Summary

Modifier and Type	Method and Description
void	beforeShipped() The action that needs to be performed before Shipper.shipped() is performed
static UserScanQueryMatcher	create(Scan scan, ScanInfo scanInfo, NavigableSet<byte[]> columns, long oldestUnexpiredTS, long now, RegionCoprocessorHost regionCoprocessorHost)
private static Cell	createStartKey(Scan scan, ScanInfo scanInfo)
Filter	getFilter()
Cell	getNextKeyHint(Cell cell) Delegate to Filter.getNextCellHint(Cell).
boolean	hasNullColumnInQuery()
protected abstract boolean	isGet()
boolean	isUserScan()
protected ScanQueryMatcher.MatchCode	matchColumn(Cell cell, long timestamp, byte typeByte)
private ScanQueryMatcher.MatchCode	mergeFilterResponse(Cell cell, ScanQueryMatcher.MatchCode matchCode, Filter.ReturnCode filterResponse) Call this when scan has filter.
boolean	moreRowsMayExistAfter(Cell cell)
protected abstract boolean	moreRowsMayExistsAfter(int cmpToStopRow)

Methods inherited from class org.apache.hadoop.hbase.regionserver.querymatcher.ScanQueryMatcher

checkColumn, checkDeleted, clearCurrentRow, compareKeyForNextColumn, compareKeyForNextRow, createStartKeyFromRow, currentRow, getKeyForNextColumn, getStartKey, getTrackers, match, preCheck, reset, setToNewRow

Methods inherited from class java.lang.Object

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

Field Detail

hasNullColumn

protected final boolean hasNullColumn

filter

protected final Filter filter

stopRow

protected final byte[] stopRow

tr

protected final TimeRange tr

versionsAfterFilter

private final int versionsAfterFilter

count

private int count

curColCell

private Cell curColCell

Constructor Detail

UserScanQueryMatcher

protected UserScanQueryMatcher(Scan scan,
                               ScanInfo scanInfo,
                               ColumnTracker columns,
                               boolean hasNullColumn,
                               long oldestUnexpiredTS,
                               long now)

Method Detail

createStartKey

private static Cell createStartKey(Scan scan,
                                   ScanInfo scanInfo)

hasNullColumnInQuery

public boolean hasNullColumnInQuery()

Specified by:

hasNullColumnInQuery in class ScanQueryMatcher

Returns:

whether there is an null column in the query

isUserScan

public boolean isUserScan()

Specified by:

isUserScan in class ScanQueryMatcher

getFilter

public Filter getFilter()

Specified by:

getFilter in class ScanQueryMatcher

Returns:

the Filter

getNextKeyHint

public Cell getNextKeyHint(Cell cell)
                    throws IOException

Description copied from class: ScanQueryMatcher

Delegate to Filter.getNextCellHint(Cell). If no filter, return null.

Specified by:

getNextKeyHint in class ScanQueryMatcher

Throws:

IOException

beforeShipped

public void beforeShipped()
                   throws IOException

Description copied from interface: ShipperListener

The action that needs to be performed before Shipper.shipped() is performed

Specified by:

beforeShipped in interface ShipperListener

Overrides:

beforeShipped in class ScanQueryMatcher

Throws:

IOException

matchColumn

protected final ScanQueryMatcher.MatchCode matchColumn(Cell cell,
                                                       long timestamp,
                                                       byte typeByte)
                                                throws IOException

Throws:

IOException

mergeFilterResponse

private final ScanQueryMatcher.MatchCode mergeFilterResponse(Cell cell,
                                                             ScanQueryMatcher.MatchCode matchCode,
                                                             Filter.ReturnCode filterResponse)

Call this when scan has filter. Decide the desired behavior by checkVersions's MatchCode and filterCell's ReturnCode. Cell may be skipped by filter, so the column versions in result may be less than user need. It need to check versions again when filter and columnTracker both include the cell.

 ColumnChecker                FilterResponse               Desired behavior
 INCLUDE                      SKIP                         SKIP
 INCLUDE                      NEXT_COL                     SEEK_NEXT_COL or SEEK_NEXT_ROW
 INCLUDE                      NEXT_ROW                     SEEK_NEXT_ROW
 INCLUDE                      SEEK_NEXT_USING_HINT         SEEK_NEXT_USING_HINT
 INCLUDE                      INCLUDE                      INCLUDE
 INCLUDE                      INCLUDE_AND_NEXT_COL         INCLUDE_AND_SEEK_NEXT_COL
 INCLUDE                      INCLUDE_AND_SEEK_NEXT_ROW    INCLUDE_AND_SEEK_NEXT_ROW
 INCLUDE_AND_SEEK_NEXT_COL    SKIP                         SEEK_NEXT_COL
 INCLUDE_AND_SEEK_NEXT_COL    NEXT_COL                     SEEK_NEXT_COL or SEEK_NEXT_ROW
 INCLUDE_AND_SEEK_NEXT_COL    NEXT_ROW                     SEEK_NEXT_ROW
 INCLUDE_AND_SEEK_NEXT_COL    SEEK_NEXT_USING_HINT         SEEK_NEXT_USING_HINT
 INCLUDE_AND_SEEK_NEXT_COL    INCLUDE                      INCLUDE_AND_SEEK_NEXT_COL
 INCLUDE_AND_SEEK_NEXT_COL    INCLUDE_AND_NEXT_COL         INCLUDE_AND_SEEK_NEXT_COL
 INCLUDE_AND_SEEK_NEXT_COL    INCLUDE_AND_SEEK_NEXT_ROW    INCLUDE_AND_SEEK_NEXT_ROW
 INCLUDE_AND_SEEK_NEXT_ROW    SKIP                         SEEK_NEXT_ROW
 INCLUDE_AND_SEEK_NEXT_ROW    NEXT_COL                     SEEK_NEXT_ROW
 INCLUDE_AND_SEEK_NEXT_ROW    NEXT_ROW                     SEEK_NEXT_ROW
 INCLUDE_AND_SEEK_NEXT_ROW    SEEK_NEXT_USING_HINT         SEEK_NEXT_USING_HINT
 INCLUDE_AND_SEEK_NEXT_ROW    INCLUDE                      INCLUDE_AND_SEEK_NEXT_ROW
 INCLUDE_AND_SEEK_NEXT_ROW    INCLUDE_AND_NEXT_COL         INCLUDE_AND_SEEK_NEXT_ROW
 INCLUDE_AND_SEEK_NEXT_ROW    INCLUDE_AND_SEEK_NEXT_ROW    INCLUDE_AND_SEEK_NEXT_ROW
 

isGet

protected abstract boolean isGet()

moreRowsMayExistsAfter

protected abstract boolean moreRowsMayExistsAfter(int cmpToStopRow)

moreRowsMayExistAfter

public boolean moreRowsMayExistAfter(Cell cell)

Specified by:

moreRowsMayExistAfter in class ScanQueryMatcher

Returns:

Returns false if we know there are no more rows to be scanned (We've reached the stopRow or we are scanning on row only because this Scan is for a Get, etc.

create

public static UserScanQueryMatcher create(Scan scan,
                                          ScanInfo scanInfo,
                                          NavigableSet<byte[]> columns,
                                          long oldestUnexpiredTS,
                                          long now,
                                          RegionCoprocessorHost regionCoprocessorHost)
                                   throws IOException

Throws:

IOException