StoreFileReader (Apache HBase - Server 2.5.4 API)

java.lang.Object
- org.apache.hadoop.hbase.regionserver.StoreFileReader

Direct Known Subclasses:: HalfStoreFileReader

@InterfaceAudience.LimitedPrivate(value="Phoenix")
 @InterfaceStability.Evolving
public class StoreFileReader
extends Object

Reader for a StoreFile.

Field Summary

Fields
Modifier and Type	Field and Description
`protected BloomType`	`bloomFilterType`
`protected org.apache.hadoop.conf.Configuration`	`conf`
`protected BloomFilter`	`deleteFamilyBloomFilter`
`protected BloomFilter`	`generalBloomFilter`
`protected long`	`sequenceID`
`protected TimeRange`	`timeRange`

Constructor Summary

Constructors
Constructor and Description
`StoreFileReader(ReaderContext context, HFileInfo fileInfo, CacheConfig cacheConf, AtomicInteger refCount, org.apache.hadoop.conf.Configuration conf)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`close(boolean evictOnClose)`
`BloomType`	`getBloomFilterType()`
`CellComparator`	`getComparator()`
`long`	`getDeleteFamilyCnt()`
`long`	`getEntries()`
`long`	`getFilterEntries()` The number of Bloom filter entries in this store file, or an estimate thereof, if the Bloom filter is not loaded.
`Optional<Cell>`	`getFirstKey()`
`int`	`getHFileMinorVersion()`
`HFile.Reader`	`getHFileReader()`
`int`	`getHFileVersion()`
`Optional<Cell>`	`getLastKey()`
`Optional<byte[]>`	`getLastRowKey()`
`long`	`getMaxTimestamp()`
`int`	`getPrefixLength()`
`ReaderContext`	`getReaderContext()`
`HFileScanner`	`getScanner(boolean cacheBlocks, boolean pread)` Deprecated. since 2.0.0 and will be removed in 3.0.0. Do not write further code which depends on this call. Instead use getStoreFileScanner() which uses the StoreFileScanner class/interface which is the preferred way to scan a store with higher level concepts.
`HFileScanner`	`getScanner(boolean cacheBlocks, boolean pread, boolean isCompaction)` Deprecated. since 2.0.0 and will be removed in 3.0.0. Do not write further code which depends on this call. Instead use getStoreFileScanner() which uses the StoreFileScanner class/interface which is the preferred way to scan a store with higher level concepts. should we cache the blocks? use pread (for concurrent small readers) is scanner being used for compaction?
`long`	`getSequenceID()`
`StoreFileScanner`	`getStoreFileScanner(boolean cacheBlocks, boolean pread, boolean isCompaction, long readPt, long scannerOrder, boolean canOptimizeForNonNullColumn)` Get a scanner to scan over this StoreFile.
`long`	`getTotalBloomSize()`
`long`	`getTotalUncompressedBytes()`
`long`	`indexSize()`
`boolean`	`isBulkLoaded()`
`boolean`	`isPrimaryReplicaReader()`
`long`	`length()`
`void`	`loadBloomfilter()`
`void`	`loadBloomfilter(BlockType blockType, BloomFilterMetrics metrics)`
`Map<byte[],byte[]>`	`loadFileInfo()`
`Optional<Cell>`	`midKey()`
`boolean`	`passesDeleteFamilyBloomFilter(byte[] row, int rowOffset, int rowLen)`
`boolean`	`passesGeneralRowColBloomFilter(Cell cell)` A method for checking Bloom filters.
`boolean`	`passesKeyRangeFilter(Scan scan)` Checks whether the given scan rowkey range overlaps with the current storefile's
`void`	`setBulkLoaded(boolean bulkLoadResult)`
`void`	`setDeleteFamilyBloomFilterFaulty()`
`void`	`setGeneralBloomFilterFaulty()`
`void`	`setSequenceID(long sequenceID)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

generalBloomFilter

protected BloomFilter generalBloomFilter

deleteFamilyBloomFilter

protected BloomFilter deleteFamilyBloomFilter

bloomFilterType
```
protected BloomType bloomFilterType
```

sequenceID
```
protected long sequenceID
```

timeRange
```
protected TimeRange timeRange
```

conf

protected org.apache.hadoop.conf.Configuration conf

Constructor Detail

StoreFileReader

public StoreFileReader(ReaderContext context,
                       HFileInfo fileInfo,
                       CacheConfig cacheConf,
                       AtomicInteger refCount,
                       org.apache.hadoop.conf.Configuration conf)
                throws IOException

Throws:: IOException

Method Detail
- isPrimaryReplicaReader
```
public boolean isPrimaryReplicaReader()
```
- getComparator
```
public CellComparator getComparator()
```
- getStoreFileScanner
```
public StoreFileScanner getStoreFileScanner(boolean cacheBlocks,
                                            boolean pread,
                                            boolean isCompaction,
                                            long readPt,
                                            long scannerOrder,
                                            boolean canOptimizeForNonNullColumn)
```
  Get a scanner to scan over this StoreFile.
  
  Parameters:
  
  cacheBlocks - should this scanner cache blocks?
  
  pread - use pread (for highly concurrent small readers)
  
  isCompaction - is scanner being used for compaction?
  
  scannerOrder - Order of this scanner relative to other scanners. See KeyValueScanner.getScannerOrder().
  
  canOptimizeForNonNullColumn - true if we can make sure there is no null column, otherwise false. This is a hint for optimization.
  
  Returns:
  
  a scanner
- getScanner
```
@Deprecated
public HFileScanner getScanner(boolean cacheBlocks,
                                           boolean pread)
```
  Deprecated. since 2.0.0 and will be removed in 3.0.0. Do not write further code which depends on this call. Instead use getStoreFileScanner() which uses the StoreFileScanner class/interface which is the preferred way to scan a store with higher level concepts.
  
  Parameters:
  
  cacheBlocks - should we cache the blocks?
  
  pread - use pread (for concurrent small readers)
  
  Returns:
  
  the underlying HFileScanner
  
  See Also:
  
  HBASE-15296
- getScanner
```
@Deprecated
public HFileScanner getScanner(boolean cacheBlocks,
                                           boolean pread,
                                           boolean isCompaction)
```
  Deprecated. since 2.0.0 and will be removed in 3.0.0. Do not write further code which depends on this call. Instead use getStoreFileScanner() which uses the StoreFileScanner class/interface which is the preferred way to scan a store with higher level concepts. should we cache the blocks? use pread (for concurrent small readers) is scanner being used for compaction?
  
  Returns:
  
  the underlying HFileScanner
  
  See Also:
  
  HBASE-15296
- close
```
public void close(boolean evictOnClose)
           throws IOException
```
  Throws:
  
  IOException
- passesDeleteFamilyBloomFilter
```
public boolean passesDeleteFamilyBloomFilter(byte[] row,
                                             int rowOffset,
                                             int rowLen)
```
- passesGeneralRowColBloomFilter
```
public boolean passesGeneralRowColBloomFilter(Cell cell)
```
  A method for checking Bloom filters. Called directly from StoreFileScanner in case of a multi-column query. the cell to check if present in BloomFilter
  
  Returns:
  
  True if passes
- passesKeyRangeFilter
```
public boolean passesKeyRangeFilter(Scan scan)
```
  Checks whether the given scan rowkey range overlaps with the current storefile's
  
  Parameters:
  
  scan - the scan specification. Used to determine the rowkey range.
  
  Returns:
  
  true if there is overlap, false otherwise
- loadFileInfo
```
public Map<byte[],byte[]> loadFileInfo()
                                throws IOException
```
  Throws:
  
  IOException
- loadBloomfilter
```
public void loadBloomfilter()
```
- loadBloomfilter
```
public void loadBloomfilter(BlockType blockType,
                            BloomFilterMetrics metrics)
```
- getFilterEntries
```
public long getFilterEntries()
```
  The number of Bloom filter entries in this store file, or an estimate thereof, if the Bloom filter is not loaded. This always returns an upper bound of the number of Bloom filter entries.
  
  Returns:
  
  an estimate of the number of Bloom filter entries in this file
- setGeneralBloomFilterFaulty
```
public void setGeneralBloomFilterFaulty()
```
- setDeleteFamilyBloomFilterFaulty
```
public void setDeleteFamilyBloomFilterFaulty()
```
- getLastKey
```
public Optional<Cell> getLastKey()
```
- getLastRowKey
```
public Optional<byte[]> getLastRowKey()
```
- midKey
```
public Optional<Cell> midKey()
                      throws IOException
```
  Throws:
  
  IOException
- length
```
public long length()
```
- getTotalUncompressedBytes
```
public long getTotalUncompressedBytes()
```
- getEntries
```
public long getEntries()
```
- getDeleteFamilyCnt
```
public long getDeleteFamilyCnt()
```
- getFirstKey
```
public Optional<Cell> getFirstKey()
```
- indexSize
```
public long indexSize()
```
- getBloomFilterType
```
public BloomType getBloomFilterType()
```
- getSequenceID
```
public long getSequenceID()
```
- setSequenceID
```
public void setSequenceID(long sequenceID)
```
- setBulkLoaded
```
public void setBulkLoaded(boolean bulkLoadResult)
```
- isBulkLoaded
```
public boolean isBulkLoaded()
```
- getTotalBloomSize
```
public long getTotalBloomSize()
```
- getHFileVersion
```
public int getHFileVersion()
```
- getHFileMinorVersion
```
public int getHFileMinorVersion()
```
- getHFileReader
```
public HFile.Reader getHFileReader()
```
- getMaxTimestamp
```
public long getMaxTimestamp()
```
- getPrefixLength
```
public int getPrefixLength()
```
- getReaderContext
```
public ReaderContext getReaderContext()
```

Class StoreFileReader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

generalBloomFilter

deleteFamilyBloomFilter

bloomFilterType

sequenceID

timeRange

conf

Constructor Detail

StoreFileReader

Method Detail

isPrimaryReplicaReader

getComparator

getStoreFileScanner

getScanner

getScanner

close

passesDeleteFamilyBloomFilter

passesGeneralRowColBloomFilter

passesKeyRangeFilter

loadFileInfo

loadBloomfilter

loadBloomfilter

getFilterEntries

setGeneralBloomFilterFaulty

setDeleteFamilyBloomFilterFaulty

getLastKey

getLastRowKey

midKey

length

getTotalUncompressedBytes

getEntries

getDeleteFamilyCnt

getFirstKey

indexSize

getBloomFilterType

getSequenceID

setSequenceID

setBulkLoaded

isBulkLoaded

getTotalBloomSize

getHFileVersion

getHFileMinorVersion

getHFileReader

getMaxTimestamp

getPrefixLength

getReaderContext