Field Detail

• stickyNextRow

  private boolean stickyNextRow

• stopRow

  private final byte[] stopRow

• tr

  private final TimeRange tr

• filter

  private final Filter filter

• deletes

  private final DeleteTracker deletes

  Keeps track of deletes

• retainDeletesInOutput

  private boolean retainDeletesInOutput

  whether to retain delete markers

• keepDeletedCells

  private final KeepDeletedCells keepDeletedCells

  whether to return deleted rows

• seePastDeleteMarkers

  private final boolean seePastDeleteMarkers

  whether time range queries can see rows "behind" a delete

• columns

  private final ColumnTracker columns

  Keeps track of columns and versions

• startKey

  private final Cell startKey

  Key to seek to in memstore and StoreFiles

• rowComparator

  private final KeyValue.KVComparator rowComparator

  Row comparator for the region this query is for

• row

  byte[] row

  Row the query is on

• rowOffset

  int rowOffset

• rowLength

  short rowLength

• earliestPutTs

  private final long earliestPutTs

  Oldest put in any of the involved store files Used to decide whether it is ok to delete family delete marker of this store keeps deleted KVs.

• ttl

  private final long ttl

• oldestUnexpiredTS

  private final long oldestUnexpiredTS

  The oldest timestamp we are interested in, based on TTL

• now

  private final long now

• maxReadPointToTrackVersions

  protected long maxReadPointToTrackVersions

  readPoint over which the KVs are unconditionally included

• dropDeletesFromRow

  private byte[] dropDeletesFromRow

• dropDeletesToRow

  private byte[] dropDeletesToRow

• hasNullColumn

  private boolean hasNullColumn

  This variable shows whether there is an null column in the query. There always exists a null column in the wildcard column query. There maybe exists a null column in the explicit column query based on the first column.

• regionCoprocessorHost

  private RegionCoprocessorHost regionCoprocessorHost

• timeToPurgeDeletes

  private final long timeToPurgeDeletes

• isUserScan

  private final boolean isUserScan

• isReversed

  private final boolean isReversed

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

• ScanQueryMatcher

  ScanQueryMatcher(Scan scan,
                  ScanInfo scanInfo,
                  NavigableSet<byte[]> columns,
                  long oldestUnexpiredTS,
                  long now)
             throws IOException

  Throws:

  IOException

Method Detail

• instantiateDeleteTracker

  private DeleteTracker instantiateDeleteTracker()
                                          throws IOException

  Throws:

  IOException

• 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.

• checkPartialDropDeleteRange

  private void checkPartialDropDeleteRange(byte[] row,
                                 int offset,
                                 short length)

  Handle partial-drop-deletes. As we match keys in order, when we have a range from which we can drop deletes, we can set retainDeletesInOutput to false for the duration of this range only, and maintain consistency.

• 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

• getFilter

  Filter getFilter()

  Returns:

  the Filter

• 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

• checkColumn

  static ScanQueryMatcher.MatchCode checkColumn(ColumnTracker columnTracker,
                                       byte[] bytes,
                                       int offset,
                                       int length,
                                       long ttl,
                                       byte type,
                                       boolean ignoreCount)
                                         throws IOException

  Throws:

  IOException

• createNextOnRowCol

  private static Cell createNextOnRowCol(Cell cell)

  Returns:

  An new cell is located following input cell. If both of type and timestamp are minimum, the input cell will be returned directly.

• createNextOnRowCol

  private static Cell createNextOnRowCol(Cell cell,
                        long ts,
                        byte type)