@InterfaceAudience.Private public class HStore extends java.lang.Object implements Store
There's no reason to consider append-logging at this level; all logging and locking is handled at the HRegion level. Store just provides services to manage sets of StoreFiles. One of the most important of those services is compaction services where files are aggregated once they pass a configurable threshold.
The only thing having to do with logs that Store needs to deal with is the reconstructionLog. This is a segment of an HRegion's log that might NOT be present upon startup. If the param is NULL, there's nothing to do. If the param is non-NULL, we need to process the log to reconstruct a TreeMap that might not have been written to disk before the process died.
It's assumed that after this constructor returns, the reconstructionLog file will be deleted (by whoever has instantiated the Store).
Locking and transactions are handled at a higher level. This API should not be called directly but by an HRegion manager.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
BLOCKING_STOREFILES_KEY |
protected int |
blocksize |
protected int |
bytesPerChecksum |
protected CacheConfig |
cacheConf |
protected ChecksumType |
checksumType
Checksum configuration
|
static java.lang.String |
COMPACTCHECKER_INTERVAL_MULTIPLIER_KEY |
protected Configuration |
conf |
protected Encryption.Context |
cryptoContext |
static long |
DEEP_OVERHEAD |
static int |
DEFAULT_BLOCKING_STOREFILE_COUNT |
static int |
DEFAULT_COMPACTCHECKER_INTERVAL_MULTIPLIER |
static long |
FIXED_OVERHEAD |
protected MemStore |
memstore |
protected HRegion |
region |
NO_PRIORITY, PRIORITY_USER
Modifier | Constructor and Description |
---|---|
protected |
HStore(HRegion region,
HColumnDescriptor family,
Configuration confParam)
Constructor
|
Modifier and Type | Method and Description |
---|---|
Pair<java.lang.Long,Cell> |
add(Cell cell)
Adds a value to the memstore
|
void |
addChangedReaderObserver(ChangedReadersObserver o) |
boolean |
areWritesEnabled() |
void |
assertBulkLoadHFileOk(Path srcPath)
This throws a WrongRegionException if the HFile does not fit in this region, or an
InvalidHFileException if the HFile is not valid.
|
Path |
bulkLoadHFile(byte[] family,
java.lang.String srcPathStr,
Path dstPath)
This method should only be called from Region.
|
void |
bulkLoadHFile(StoreFileInfo fileInfo) |
void |
cancelRequestedCompaction(CompactionContext compaction) |
boolean |
canSplit() |
<any> |
close()
Close all the readers We don't need to worry about subsequent requests because the Region
holds a write lock that will prevent any more reads or writes.
|
java.util.List<StoreFile> |
compact(CompactionContext compaction,
CompactionThroughputController throughputController)
Compact the StoreFiles.
|
java.util.List<StoreFile> |
compact(CompactionContext compaction,
CompactionThroughputController throughputController,
User user) |
void |
compactRecentForTestingAssumingDefaultPolicy(int N)
This method tries to compact N recent files for testing.
|
protected void |
completeCompaction(java.util.Collection<StoreFile> compactedFiles)
It works by processing a compaction that's been written to disk.
|
protected void |
completeCompaction(java.util.Collection<StoreFile> compactedFiles,
boolean removeFiles)
It works by processing a compaction that's been written to disk.
|
protected void |
createCacheConf(HColumnDescriptor family)
Creates the cache config.
|
org.apache.hadoop.hbase.regionserver.StoreFlushContext |
createFlushContext(long cacheFlushId) |
protected KeyValueScanner |
createScanner(Scan scan,
java.util.NavigableSet<byte[]> targetCols,
long readPt,
KeyValueScanner scanner) |
protected StoreEngine<?,?,?,?> |
createStoreEngine(Store store,
Configuration conf,
KeyValue.KVComparator kvComparator)
Creates the store engine configured for the given Store.
|
StoreFile.Writer |
createWriterInTmp(long maxKeyCount,
Compression.Algorithm compression,
boolean isCompaction,
boolean includeMVCCReadpoint,
boolean includesTag) |
protected long |
delete(KeyValue kv)
Adds a value to the memstore
|
void |
deleteChangedReaderObserver(ChangedReadersObserver o) |
void |
deregisterChildren(ConfigurationManager manager)
Needs to be called to deregister the children from the manager.
|
static long |
determineTTLFromFamily(HColumnDescriptor family) |
protected java.util.List<Path> |
flushCache(long logCacheFlushId,
MemStoreSnapshot snapshot,
MonitoredTask status)
Write out current snapshot.
|
long |
getAvgStoreFileAge() |
long |
getBlockingFileCount()
The number of files required before flushes for this store will be blocked.
|
static int |
getBytesPerChecksum(Configuration conf)
Returns the configured bytesPerChecksum value.
|
CacheConfig |
getCacheConfig()
Used for tests.
|
static ChecksumType |
getChecksumType(Configuration conf)
Returns the configured checksum algorithm.
|
static int |
getCloseCheckInterval() |
java.lang.String |
getColumnFamilyName() |
long |
getCompactedCellsCount() |
long |
getCompactedCellsSize() |
long |
getCompactionCheckMultiplier() |
double |
getCompactionPressure()
This value can represent the degree of emergency of compaction for this store.
|
CompactionProgress |
getCompactionProgress()
getter for CompactionProgress object
|
int |
getCompactPriority() |
KeyValue.KVComparator |
getComparator() |
RegionCoprocessorHost |
getCoprocessorHost() |
HFileDataBlockEncoder |
getDataBlockEncoder() |
HColumnDescriptor |
getFamily() |
FileSystem |
getFileSystem() |
long |
getFlushableSize() |
long |
getFlushedCellsCount() |
long |
getFlushedCellsSize() |
long |
getFlushedOutputFileSize() |
HRegion |
getHRegion() |
long |
getLastCompactSize() |
long |
getMajorCompactedCellsCount() |
long |
getMajorCompactedCellsSize() |
long |
getMaxMemstoreTS() |
long |
getMaxSequenceId() |
long |
getMaxStoreFileAge() |
long |
getMemstoreFlushSize() |
long |
getMemStoreSize() |
long |
getMinStoreFileAge() |
long |
getNumHFiles() |
long |
getNumReferenceFiles() |
protected OffPeakHours |
getOffPeakHours() |
HRegionFileSystem |
getRegionFileSystem() |
HRegionInfo |
getRegionInfo() |
Cell |
getRowKeyAtOrBefore(byte[] row)
Find the key that matches row exactly, or the one that immediately precedes it.
|
ScanInfo |
getScanInfo() |
KeyValueScanner |
getScanner(Scan scan,
java.util.NavigableSet<byte[]> targetCols,
long readPt)
Return a scanner for both the memstore and the HStore files.
|
java.util.List<KeyValueScanner> |
getScanners(boolean cacheBlocks,
boolean isGet,
boolean usePread,
boolean isCompaction,
ScanQueryMatcher matcher,
byte[] startRow,
byte[] stopRow,
long readPt)
Get all scanners with no filtering based on TTL (that happens further down
the line).
|
long |
getSize() |
long |
getSmallestReadPoint() |
long |
getSnapshotSize()
Returns the memstore snapshot size
|
byte[] |
getSplitPoint()
Determines if Store should be split
|
StoreEngine<?,?,?,?> |
getStoreEngine()
Returns the StoreEngine that is backing this concrete implementation of Store.
|
java.util.Collection<StoreFile> |
getStorefiles() |
int |
getStorefilesCount() |
long |
getStorefilesIndexSize() |
long |
getStorefilesSize() |
long |
getStoreFileTtl() |
static Path |
getStoreHomedir(Path tabledir,
HRegionInfo hri,
byte[] family)
Deprecated.
|
static Path |
getStoreHomedir(Path tabledir,
java.lang.String encodedName,
byte[] family)
Deprecated.
|
long |
getStoreSizeUncompressed() |
TableName |
getTableName() |
long |
getTotalStaticBloomSize()
Returns the total byte size of all Bloom filter bit arrays.
|
long |
getTotalStaticIndexSize()
Returns the total size of all index blocks in the data block indexes, including the root level,
intermediate levels, and the leaf level for multi-level indexes, or just the root level for
single-level indexes.
|
boolean |
hasReferences() |
boolean |
hasTooManyStoreFiles() |
long |
heapSize() |
boolean |
isMajorCompaction() |
boolean |
isPrimaryReplicaStore() |
boolean |
needsCompaction()
See if there's too much store files in this store
|
void |
onConfigurationChange(Configuration conf)
This method would be called by the
ConfigurationManager
object when the Configuration object is reloaded from disk. |
Pair<Path,Path> |
preBulkLoadHFile(java.lang.String srcPathStr,
long seqNum) |
void |
refreshStoreFiles()
Checks the underlying store files, and opens the files that have not
been opened, and removes the store file readers for store files no longer
available.
|
void |
refreshStoreFiles(java.util.Collection<java.lang.String> newFiles)
Replaces the store files that the store has with the given files.
|
void |
registerChildren(ConfigurationManager manager)
Needs to be called to register the children to the manager.
|
void |
replayCompactionMarker(WALProtos.CompactionDescriptor compaction,
boolean pickCompactionFiles,
boolean removeFiles)
Call to complete a compaction.
|
CompactionContext |
requestCompaction() |
CompactionContext |
requestCompaction(int priority,
CompactionRequest baseRequest) |
CompactionContext |
requestCompaction(int priority,
CompactionRequest baseRequest,
User user) |
void |
rollback(Cell cell)
Removes a Cell from the memstore.
|
boolean |
throttleCompaction(long compactionSize) |
long |
timeOfOldestEdit()
When was the last edit done in the memstore
|
java.lang.String |
toString() |
void |
triggerMajorCompaction() |
long |
updateColumnValue(byte[] row,
byte[] f,
byte[] qualifier,
long newValue)
Used in tests.
|
long |
upsert(java.lang.Iterable<Cell> cells,
long readpoint)
Adds or replaces the specified KeyValues.
|
public static final java.lang.String COMPACTCHECKER_INTERVAL_MULTIPLIER_KEY
public static final java.lang.String BLOCKING_STOREFILES_KEY
public static final int DEFAULT_COMPACTCHECKER_INTERVAL_MULTIPLIER
public static final int DEFAULT_BLOCKING_STOREFILE_COUNT
protected final MemStore memstore
protected final HRegion region
protected Configuration conf
protected CacheConfig cacheConf
protected final int blocksize
protected ChecksumType checksumType
protected int bytesPerChecksum
protected Encryption.Context cryptoContext
public static final long FIXED_OVERHEAD
public static final long DEEP_OVERHEAD
protected HStore(HRegion region, HColumnDescriptor family, Configuration confParam) throws java.io.IOException
region
- family
- HColumnDescriptor for this columnconfParam
- configuration object
failed. Can be null.java.io.IOException
protected void createCacheConf(HColumnDescriptor family)
family
- The current column family.protected StoreEngine<?,?,?,?> createStoreEngine(Store store, Configuration conf, KeyValue.KVComparator kvComparator) throws java.io.IOException
store
- The store. An unfortunate dependency needed due to it
being passed to coprocessors via the compactor.conf
- Store configuration.kvComparator
- KVComparator for storeFileManager.java.io.IOException
public static long determineTTLFromFamily(HColumnDescriptor family)
family
- public java.lang.String getColumnFamilyName()
getColumnFamilyName
in interface Store
public TableName getTableName()
getTableName
in interface Store
public FileSystem getFileSystem()
getFileSystem
in interface Store
public HRegionFileSystem getRegionFileSystem()
public long getStoreFileTtl()
getStoreFileTtl
in interface StoreConfigInformation
public long getMemstoreFlushSize()
getMemstoreFlushSize
in interface StoreConfigInformation
public long getFlushableSize()
getFlushableSize
in interface Store
Store.getMemStoreSize()
unless we are carrying snapshots and then it will be the size of
outstanding snapshots.public long getSnapshotSize()
Store
getSnapshotSize
in interface Store
public long getCompactionCheckMultiplier()
getCompactionCheckMultiplier
in interface StoreConfigInformation
public long getBlockingFileCount()
StoreConfigInformation
getBlockingFileCount
in interface StoreConfigInformation
public static int getBytesPerChecksum(Configuration conf)
conf
- The configurationpublic static ChecksumType getChecksumType(Configuration conf)
conf
- The configurationpublic static int getCloseCheckInterval()
public HColumnDescriptor getFamily()
public long getMaxSequenceId()
getMaxSequenceId
in interface Store
public long getMaxMemstoreTS()
getMaxMemstoreTS
in interface Store
@Deprecated public static Path getStoreHomedir(Path tabledir, HRegionInfo hri, byte[] family)
tabledir
- Path
to where the table is being storedhri
- HRegionInfo
for the region.family
- HColumnDescriptor
describing the column family@Deprecated public static Path getStoreHomedir(Path tabledir, java.lang.String encodedName, byte[] family)
tabledir
- Path
to where the table is being storedencodedName
- Encoded region name.family
- HColumnDescriptor
describing the column familypublic HFileDataBlockEncoder getDataBlockEncoder()
getDataBlockEncoder
in interface Store
public void refreshStoreFiles() throws java.io.IOException
refreshStoreFiles
in interface Store
java.io.IOException
public void refreshStoreFiles(java.util.Collection<java.lang.String> newFiles) throws java.io.IOException
Store
refreshStoreFiles
in interface Store
java.io.IOException
public Pair<java.lang.Long,Cell> add(Cell cell)
Store
public long timeOfOldestEdit()
Store
timeOfOldestEdit
in interface Store
protected long delete(KeyValue kv)
kv
- public void rollback(Cell cell)
Store
public java.util.Collection<StoreFile> getStorefiles()
getStorefiles
in interface Store
public void assertBulkLoadHFileOk(Path srcPath) throws java.io.IOException
Store
assertBulkLoadHFileOk
in interface Store
java.io.IOException
public Pair<Path,Path> preBulkLoadHFile(java.lang.String srcPathStr, long seqNum) throws java.io.IOException
java.io.IOException
public Path bulkLoadHFile(byte[] family, java.lang.String srcPathStr, Path dstPath) throws java.io.IOException
Store
bulkLoadHFile
in interface Store
family
- the column familyjava.io.IOException
public void bulkLoadHFile(StoreFileInfo fileInfo) throws java.io.IOException
bulkLoadHFile
in interface Store
java.io.IOException
public <any> close() throws java.io.IOException
Store
close
in interface Store
StoreFiles
that were previously being used.java.io.IOException
- on failureprotected java.util.List<Path> flushCache(long logCacheFlushId, MemStoreSnapshot snapshot, MonitoredTask status) throws java.io.IOException
snapshot()
has been called
previously.logCacheFlushId
- flush sequence numbersnapshot
- status
- java.io.IOException
public StoreFile.Writer createWriterInTmp(long maxKeyCount, Compression.Algorithm compression, boolean isCompaction, boolean includeMVCCReadpoint, boolean includesTag) throws java.io.IOException
createWriterInTmp
in interface Store
java.io.IOException
public java.util.List<KeyValueScanner> getScanners(boolean cacheBlocks, boolean isGet, boolean usePread, boolean isCompaction, ScanQueryMatcher matcher, byte[] startRow, byte[] stopRow, long readPt) throws java.io.IOException
getScanners
in interface Store
java.io.IOException
public void addChangedReaderObserver(ChangedReadersObserver o)
addChangedReaderObserver
in interface Store
public void deleteChangedReaderObserver(ChangedReadersObserver o)
deleteChangedReaderObserver
in interface Store
public java.util.List<StoreFile> compact(CompactionContext compaction, CompactionThroughputController throughputController) throws java.io.IOException
During this time, the Store can work as usual, getting values from StoreFiles and writing new StoreFiles from the memstore. Existing StoreFiles are not destroyed until the new compacted StoreFile is completely written-out to disk.
The compactLock prevents multiple simultaneous compactions. The structureLock prevents us from interfering with other write operations.
We don't want to hold the structureLock for the whole time, as a compact() can be lengthy and we want to allow cache-flushes during this period.
Compaction event should be idempotent, since there is no IO Fencing for the region directory in hdfs. A region server might still try to complete the compaction after it lost the region. That is why the following events are carefully ordered for a compaction: 1. Compaction writes new files under region/.tmp directory (compaction output) 2. Compaction atomically moves the temporary file under region directory 3. Compaction appends a WAL edit containing the compaction input and output files. Forces sync on WAL. 4. Compaction deletes the input files from the region directory. Failure conditions are handled like this: - If RS fails before 2, compaction wont complete. Even if RS lives on and finishes the compaction later, it will only write the new data file to the region directory. Since we already have this data, this will be idempotent but we will have a redundant copy of the data. - If RS fails between 2 and 3, the region will have a redundant copy of the data. The RS that failed won't be able to finish snyc() for WAL because of lease recovery in WAL. - If RS fails after 3, the region region server who opens the region will pick up the the compaction marker from the WAL and replay it by removing the compaction input files. Failed RS can also attempt to delete those files, but the operation will be idempotent See HBASE-2231 for details.
public java.util.List<StoreFile> compact(CompactionContext compaction, CompactionThroughputController throughputController, User user) throws java.io.IOException
public void replayCompactionMarker(WALProtos.CompactionDescriptor compaction, boolean pickCompactionFiles, boolean removeFiles) throws java.io.IOException
replayCompactionMarker
in interface Store
compaction
- pickCompactionFiles
- whether or not pick up the new compaction output files and
add it to the storeremoveFiles
- whether to remove/archive files from filesystemjava.io.IOException
public void compactRecentForTestingAssumingDefaultPolicy(int N) throws java.io.IOException
N
- Number of files.java.io.IOException
public boolean hasReferences()
hasReferences
in interface Store
public CompactionProgress getCompactionProgress()
Store
getCompactionProgress
in interface Store
public boolean isMajorCompaction() throws java.io.IOException
isMajorCompaction
in interface Store
java.io.IOException
public CompactionContext requestCompaction() throws java.io.IOException
requestCompaction
in interface Store
java.io.IOException
public CompactionContext requestCompaction(int priority, CompactionRequest baseRequest) throws java.io.IOException
requestCompaction
in interface Store
java.io.IOException
public CompactionContext requestCompaction(int priority, CompactionRequest baseRequest, User user) throws java.io.IOException
requestCompaction
in interface Store
java.io.IOException
public void cancelRequestedCompaction(CompactionContext compaction)
cancelRequestedCompaction
in interface Store
protected void completeCompaction(java.util.Collection<StoreFile> compactedFiles) throws java.io.IOException
It works by processing a compaction that's been written to disk.
It is usually invoked at the end of a compaction, but might also be invoked at HStore startup, if the prior execution died midway through.
Moving the compacted TreeMap into place means:
1) Unload all replaced StoreFile, close and collect list to delete. 2) Compute new store size
compactedFiles
- list of files that were compactedjava.io.IOException
protected void completeCompaction(java.util.Collection<StoreFile> compactedFiles, boolean removeFiles) throws java.io.IOException
It works by processing a compaction that's been written to disk.
It is usually invoked at the end of a compaction, but might also be invoked at HStore startup, if the prior execution died midway through.
Moving the compacted TreeMap into place means:
1) Unload all replaced StoreFile, close and collect list to delete. 2) Compute new store size
compactedFiles
- list of files that were compactedjava.io.IOException
public Cell getRowKeyAtOrBefore(byte[] row) throws java.io.IOException
Store
getRowKeyAtOrBefore
in interface Store
row
- The row key of the targeted row.java.io.IOException
public byte[] getSplitPoint()
Store
getSplitPoint
in interface Store
public long getLastCompactSize()
getLastCompactSize
in interface Store
public long getSize()
public void triggerMajorCompaction()
triggerMajorCompaction
in interface Store
public KeyValueScanner getScanner(Scan scan, java.util.NavigableSet<byte[]> targetCols, long readPt) throws java.io.IOException
Store
getScanner
in interface Store
scan
- Scan to apply when scanning the storestargetCols
- columns to scanjava.io.IOException
- on failureprotected KeyValueScanner createScanner(Scan scan, java.util.NavigableSet<byte[]> targetCols, long readPt, KeyValueScanner scanner) throws java.io.IOException
java.io.IOException
public java.lang.String toString()
toString
in class java.lang.Object
public int getStorefilesCount()
getStorefilesCount
in interface Store
public long getMaxStoreFileAge()
getMaxStoreFileAge
in interface Store
public long getMinStoreFileAge()
getMinStoreFileAge
in interface Store
public long getAvgStoreFileAge()
getAvgStoreFileAge
in interface Store
public long getNumReferenceFiles()
getNumReferenceFiles
in interface Store
public long getNumHFiles()
getNumHFiles
in interface Store
public long getStoreSizeUncompressed()
getStoreSizeUncompressed
in interface Store
public long getStorefilesSize()
getStorefilesSize
in interface Store
public long getStorefilesIndexSize()
getStorefilesIndexSize
in interface Store
public long getTotalStaticIndexSize()
Store
getTotalStaticIndexSize
in interface Store
public long getTotalStaticBloomSize()
Store
getTotalStaticBloomSize
in interface Store
public long getMemStoreSize()
getMemStoreSize
in interface Store
public int getCompactPriority()
getCompactPriority
in interface Store
public boolean throttleCompaction(long compactionSize)
throttleCompaction
in interface Store
public HRegion getHRegion()
public RegionCoprocessorHost getCoprocessorHost()
getCoprocessorHost
in interface Store
public HRegionInfo getRegionInfo()
getRegionInfo
in interface Store
public boolean areWritesEnabled()
areWritesEnabled
in interface Store
public long getSmallestReadPoint()
getSmallestReadPoint
in interface Store
public long updateColumnValue(byte[] row, byte[] f, byte[] qualifier, long newValue) throws java.io.IOException
row
- row to updatef
- family to updatequalifier
- qualifier to updatenewValue
- the new value to set into memstorejava.io.IOException
public long upsert(java.lang.Iterable<Cell> cells, long readpoint) throws java.io.IOException
Store
For each KeyValue specified, if a cell with the same row, family, and qualifier exists in MemStore, it will be replaced. Otherwise, it will just be inserted to MemStore.
This operation is atomic on each KeyValue (row/family/qualifier) but not necessarily atomic across all of them.
public org.apache.hadoop.hbase.regionserver.StoreFlushContext createFlushContext(long cacheFlushId)
createFlushContext
in interface Store
public boolean needsCompaction()
Store
needsCompaction
in interface Store
public CacheConfig getCacheConfig()
Store
getCacheConfig
in interface Store
public long heapSize()
public KeyValue.KVComparator getComparator()
getComparator
in interface Store
public ScanInfo getScanInfo()
getScanInfo
in interface Store
public boolean hasTooManyStoreFiles()
hasTooManyStoreFiles
in interface Store
public long getFlushedCellsCount()
getFlushedCellsCount
in interface Store
public long getFlushedCellsSize()
getFlushedCellsSize
in interface Store
public long getFlushedOutputFileSize()
getFlushedOutputFileSize
in interface Store
public long getCompactedCellsCount()
getCompactedCellsCount
in interface Store
public long getCompactedCellsSize()
getCompactedCellsSize
in interface Store
public long getMajorCompactedCellsCount()
getMajorCompactedCellsCount
in interface Store
public long getMajorCompactedCellsSize()
getMajorCompactedCellsSize
in interface Store
public StoreEngine<?,?,?,?> getStoreEngine()
StoreEngine
object used internally inside this HStore object.protected OffPeakHours getOffPeakHours()
public void onConfigurationChange(Configuration conf)
ConfigurationManager
object when the Configuration
object is reloaded from disk.onConfigurationChange
in interface ConfigurationObserver
public void registerChildren(ConfigurationManager manager)
registerChildren
in interface PropagatingConfigurationObserver
manager
- : to register topublic void deregisterChildren(ConfigurationManager manager)
deregisterChildren
in interface PropagatingConfigurationObserver
manager
- : to deregister frompublic double getCompactionPressure()
Store
And for striped stores, we should calculate this value by the files in each stripe separately and return the maximum value.
It is similar to Store.getCompactPriority()
except that it is more suitable to use in a
linear formula.
getCompactionPressure
in interface Store
public boolean isPrimaryReplicaStore()
isPrimaryReplicaStore
in interface Store