org.apache.hadoop.hbase.regionserver

Class ScanQueryMatcher

java.lang.Object

org.apache.hadoop.hbase.regionserver.ScanQueryMatcher

@InterfaceAudience.Private
public class ScanQueryMatcher
extends Object

A query matcher that is specifically designed for the scan case.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScanQueryMatcher.MatchCode match(org.apache.hadoop.hbase.Cell) return codes.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	maxReadPointToTrackVersions readPoint over which the KVs are unconditionally included

Constructor Summary

Constructors

Constructor and Description
ScanQueryMatcher(Scan scan, ScanInfo scanInfo, NavigableSet<byte[]> columns, long readPointToUse, long earliestPutTs, long oldestUnexpiredTS, long now, byte[] dropDeletesFromRow, byte[] dropDeletesToRow, RegionCoprocessorHost regionCoprocessorHost) Construct a QueryMatcher for a scan that drop deletes from a limited range of rows.
ScanQueryMatcher(Scan scan, ScanInfo scanInfo, NavigableSet<byte[]> columns, ScanType scanType, long readPointToUse, long earliestPutTs, long oldestUnexpiredTS, long now, RegionCoprocessorHost regionCoprocessorHost) Construct a QueryMatcher for a scan

Method Summary

Modifier and Type	Method and Description
int	compareKeyForNextColumn(Cell nextIndexed, Cell kv)
int	compareKeyForNextRow(Cell nextIndexed, Cell kv)
Cell	getKeyForNextColumn(Cell kv)
Cell	getKeyForNextRow(Cell kv)
Cell	getNextKeyHint(Cell kv)
Cell	getStartKey()
boolean	hasNullColumnInQuery()
ScanQueryMatcher.MatchCode	match(Cell cell) Determines if the caller should do one of several things: - seek/skip to the next row (MatchCode.SEEK_NEXT_ROW) - seek/skip to the next column (MatchCode.SEEK_NEXT_COL) - include the current KeyValue (MatchCode.INCLUDE) - ignore the current KeyValue (MatchCode.SKIP) - got to the next row (MatchCode.DONE)
boolean	moreRowsMayExistAfter(Cell kv)
void	reset()
void	setRow(byte[] row, int offset, short length) Set current row

Methods inherited from class java.lang.Object

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

Field Detail

maxReadPointToTrackVersions

protected long maxReadPointToTrackVersions

readPoint over which the KVs are unconditionally included

Constructor Detail

ScanQueryMatcher

public ScanQueryMatcher(Scan scan,
                        ScanInfo scanInfo,
                        NavigableSet<byte[]> columns,
                        ScanType scanType,
                        long readPointToUse,
                        long earliestPutTs,
                        long oldestUnexpiredTS,
                        long now,
                        RegionCoprocessorHost regionCoprocessorHost)
                 throws IOException

Construct a QueryMatcher for a scan

Parameters:

scan -

scanInfo - The store's immutable scan info

columns -

scanType - Type of the scan

earliestPutTs - Earliest put seen in any of the store files.

oldestUnexpiredTS - the oldest timestamp we are interested in, based on TTL

regionCoprocessorHost -

Throws:

IOException

ScanQueryMatcher

public ScanQueryMatcher(Scan scan,
                        ScanInfo scanInfo,
                        NavigableSet<byte[]> columns,
                        long readPointToUse,
                        long earliestPutTs,
                        long oldestUnexpiredTS,
                        long now,
                        byte[] dropDeletesFromRow,
                        byte[] dropDeletesToRow,
                        RegionCoprocessorHost regionCoprocessorHost)
                 throws IOException

Construct a QueryMatcher for a scan that drop deletes from a limited range of rows.

Parameters:

scan -

scanInfo - The store's immutable scan info

columns -

earliestPutTs - Earliest put seen in any of the store files.

oldestUnexpiredTS - the oldest timestamp we are interested in, based on TTL

now - the current server time

dropDeletesFromRow - The inclusive left bound of the range; can be EMPTY_START_ROW.

dropDeletesToRow - The exclusive right bound of the range; can be EMPTY_END_ROW.

regionCoprocessorHost -

Throws:

IOException

Method Detail

hasNullColumnInQuery

public boolean hasNullColumnInQuery()

Returns:

whether there is an null column in the query

match

public ScanQueryMatcher.MatchCode match(Cell cell)
                                 throws IOException

Determines if the caller should do one of several things: - seek/skip to the next row (MatchCode.SEEK_NEXT_ROW) - seek/skip to the next column (MatchCode.SEEK_NEXT_COL) - include the current KeyValue (MatchCode.INCLUDE) - ignore the current KeyValue (MatchCode.SKIP) - got to the next row (MatchCode.DONE)

Parameters:

cell - KeyValue to check

Returns:

The match code instance.

Throws:

IOException - in case there is an internal consistency problem caused by a data corruption.

moreRowsMayExistAfter

public boolean moreRowsMayExistAfter(Cell kv)

setRow

public void setRow(byte[] row,
                   int offset,
                   short length)

Set current row

Parameters:

row -

reset

public void reset()

getStartKey

public Cell getStartKey()

Returns:

the start key

getNextKeyHint

public Cell getNextKeyHint(Cell kv)
                    throws IOException

Throws:

IOException

getKeyForNextColumn

public Cell getKeyForNextColumn(Cell kv)

getKeyForNextRow

public Cell getKeyForNextRow(Cell kv)

compareKeyForNextRow

public int compareKeyForNextRow(Cell nextIndexed,
                                Cell kv)

Parameters:

nextIndexed - the key of the next entry in the block index (if any)

kv - The Cell we're using to calculate the seek key

Returns:

result of the compare between the indexed key and the key portion of the passed cell

compareKeyForNextColumn

public int compareKeyForNextColumn(Cell nextIndexed,
                                   Cell kv)

Parameters:

nextIndexed - the key of the next entry in the block index (if any)

kv - The Cell we're using to calculate the seek key

Returns:

result of the compare between the indexed key and the key portion of the passed cell