HStore (Apache HBase - Server 1.4.14 API)

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

所有已实现的接口:

ConfigurationObserver, PropagatingConfigurationObserver, HeapSize, Store, StoreConfigInformation
```
@InterfaceAudience.Private
public class HStore
extends Object
implements Store
```
A Store holds a column family in a Region. Its a memstore and a set of zero or more StoreFiles, which stretch backwards over time.
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.
Locking and transactions are handled at a higher level. This API should not be called directly but by an HRegion manager.

字段概要

字段
限定符和类型	字段和说明
`static String`	`BLOCKING_STOREFILES_KEY`
`static String`	`COMPACTCHECKER_INTERVAL_MULTIPLIER_KEY`
`static long`	`DEEP_OVERHEAD`
`static int`	`DEFAULT_BLOCKING_STOREFILE_COUNT`
`static int`	`DEFAULT_COMPACTCHECKER_INTERVAL_MULTIPLIER`
`static long`	`FIXED_OVERHEAD`
`protected MemStore`	`memstore`

从接口继承的字段 org.apache.hadoop.hbase.regionserver.Store
NO_PRIORITY, PRIORITY_USER

构造器概要

构造器
限定符构造器和说明

protected HStore(HRegion region, HColumnDescriptor family, org.apache.hadoop.conf.Configuration confParam)
Constructor

构造器
限定符	构造器和说明
`protected`	`HStore(HRegion region, HColumnDescriptor family, org.apache.hadoop.conf.Configuration confParam)` Constructor

方法概要

方法
限定符和类型	方法和说明
`long`	`add(Cell cell)` Adds a value to the memstore
`long`	`add(Iterable<Cell> cells)` Adds the specified value to the memstore
`void`	`addChangedReaderObserver(ChangedReadersObserver o)`
`boolean`	`areWritesEnabled()`
`void`	`assertBulkLoadHFileOk(org.apache.hadoop.fs.Path srcPath)` This throws a WrongRegionException if the HFile does not fit in this region, or an InvalidHFileException if the HFile is not valid.
`org.apache.hadoop.fs.Path`	`bulkLoadHFile(byte[] family, String srcPathStr, org.apache.hadoop.fs.Path dstPath)` This method should only be called from Region.
`void`	`bulkLoadHFile(StoreFileInfo fileInfo)`
`void`	`cancelRequestedCompaction(CompactionContext compaction)`
`boolean`	`canSplit()`
`com.google.common.collect.ImmutableCollection<StoreFile>`	`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.
`void`	`closeAndArchiveCompactedFiles()` Closes and archives the compacted files under this store
`List<StoreFile>`	`compact(CompactionContext compaction, ThroughputController throughputController)` Compact the StoreFiles.
`List<StoreFile>`	`compact(CompactionContext compaction, ThroughputController throughputController, User user)`
`void`	`compactRecentForTestingAssumingDefaultPolicy(int N)` This method tries to compact N recent files for testing.
`protected void`	`completeCompaction(Collection<StoreFile> compactedFiles)` It works by processing a compaction that's been written to disk.
`protected void`	`completeCompaction(Collection<StoreFile> compactedFiles, boolean removeFiles)` It works by processing a compaction that's been written to disk.
`org.apache.hadoop.hbase.regionserver.StoreFlushContext`	`createFlushContext(long cacheFlushId)`
`StoreFile.Writer`	`createWriterInTmp(long maxKeyCount, Compression.Algorithm compression, boolean isCompaction, boolean includeMVCCReadpoint, boolean includesTag)`
`StoreFile.Writer`	`createWriterInTmp(long maxKeyCount, Compression.Algorithm compression, boolean isCompaction, boolean includeMVCCReadpoint, boolean includesTag, boolean shouldDropBehind)`
`StoreFile.Writer`	`createWriterInTmp(long maxKeyCount, Compression.Algorithm compression, boolean isCompaction, boolean includeMVCCReadpoint, boolean includesTag, boolean shouldDropBehind, TimeRangeTracker trt)`
`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.
`protected List<org.apache.hadoop.fs.Path>`	`flushCache(long logCacheFlushId, MemStoreSnapshot snapshot, MonitoredTask status, ThroughputController throughputController)` Write out current snapshot.
`long`	`getAvgStoreFileAge()`
`long`	`getBlockingFileCount()` The number of files required before flushes for this store will be blocked.
`static int`	`getBytesPerChecksum(org.apache.hadoop.conf.Configuration conf)` Returns the configured bytesPerChecksum value.
`CacheConfig`	`getCacheConfig()` Used for tests.
`static ChecksumType`	`getChecksumType(org.apache.hadoop.conf.Configuration conf)` Returns the configured checksum algorithm.
`static int`	`getCloseCheckInterval()`
`String`	`getColumnFamilyName()`
`long`	`getCompactedCellsCount()`
`long`	`getCompactedCellsSize()`
`Collection<StoreFile>`	`getCompactedfiles()`
`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()`
`org.apache.hadoop.fs.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, NavigableSet<byte[]> targetCols, long readPt)` Return a scanner for both the memstore and the HStore files.
`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).
`List<KeyValueScanner>`	`getScanners(List<StoreFile> files, boolean cacheBlocks, boolean isGet, boolean usePread, boolean isCompaction, ScanQueryMatcher matcher, byte[] startRow, byte[] stopRow, long readPt, boolean includeMemstoreScanner)` Create scanners on the given files and if needed on the memstore 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.
`Collection<StoreFile>`	`getStorefiles()`
`int`	`getStorefilesCount()`
`long`	`getStorefilesIndexSize()`
`long`	`getStorefilesSize()`
`long`	`getStoreFileTtl()`
`static org.apache.hadoop.fs.Path`	`getStoreHomedir(org.apache.hadoop.fs.Path tabledir, HRegionInfo hri, byte[] family)` 已过时。
`static org.apache.hadoop.fs.Path`	`getStoreHomedir(org.apache.hadoop.fs.Path tabledir, String encodedName, byte[] family)` 已过时。
`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()`
`static boolean`	`isCellTTLExpired(Cell cell, long oldestTimestamp, long now)`
`boolean`	`isMajorCompaction()`
`boolean`	`isPrimaryReplicaStore()`
`boolean`	`needsCompaction()` See if there's too much store files in this store
`void`	`onConfigurationChange(org.apache.hadoop.conf.Configuration conf)` This method would be called by the `ConfigurationManager` object when the `Configuration` object is reloaded from disk.
`void`	`postSnapshotOperation()` Perform tasks needed after the completion of snapshot operation.
`Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path>`	`preBulkLoadHFile(String srcPathStr, long seqNum)`
`void`	`preSnapshotOperation()` Sets the store up for a region level snapshot operation.
`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(Collection<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(org.apache.hadoop.hbase.protobuf.generated.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
`String`	`toString()`
`void`	`triggerMajorCompaction()`
`long`	`updateColumnValue(byte[] row, byte[] f, byte[] qualifier, long newValue)` Used in tests.
`long`	`upsert(Iterable<Cell> cells, long readpoint, List<Cell> removedCells)` Adds or replaces the specified KeyValues.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - COMPACTCHECKER_INTERVAL_MULTIPLIER_KEY
```
public static final String COMPACTCHECKER_INTERVAL_MULTIPLIER_KEY
```
    另请参阅:
    常量字段值
  - BLOCKING_STOREFILES_KEY
```
public static final String BLOCKING_STOREFILES_KEY
```
    另请参阅:
    常量字段值
  - DEFAULT_COMPACTCHECKER_INTERVAL_MULTIPLIER
```
public static final int DEFAULT_COMPACTCHECKER_INTERVAL_MULTIPLIER
```
    另请参阅:
    常量字段值
  - DEFAULT_BLOCKING_STOREFILE_COUNT
```
public static final int DEFAULT_BLOCKING_STOREFILE_COUNT
```
    另请参阅:
    常量字段值
  - memstore
```
protected final MemStore memstore
```
  - FIXED_OVERHEAD
```
public static final long FIXED_OVERHEAD
```
  - DEEP_OVERHEAD
```
public static final long DEEP_OVERHEAD
```
- 构造器详细资料
  - HStore
```
protected HStore(HRegion region,
      HColumnDescriptor family,
      org.apache.hadoop.conf.Configuration confParam)
          throws IOException
```
    Constructor
    
    参数:
    region -
    family - HColumnDescriptor for this column
    confParam - configuration object failed. Can be null.
    
    抛出:
    
    IOException
- 方法详细资料
  - getColumnFamilyName
```
public String getColumnFamilyName()
```
    指定者:
    
    getColumnFamilyName 在接口中 Store
  - getTableName
```
public TableName getTableName()
```
    指定者:
    
    getTableName 在接口中 Store
  - getFileSystem
```
public org.apache.hadoop.fs.FileSystem getFileSystem()
```
    指定者:
    
    getFileSystem 在接口中 Store
  - getRegionFileSystem
```
public HRegionFileSystem getRegionFileSystem()
```
  - getStoreFileTtl
```
public long getStoreFileTtl()
```
    指定者:
    
    getStoreFileTtl 在接口中 StoreConfigInformation
    
    返回:
    Gets the cf-specific time-to-live for store files.
  - getMemstoreFlushSize
```
public long getMemstoreFlushSize()
```
    指定者:
    
    getMemstoreFlushSize 在接口中 StoreConfigInformation
    
    返回:
    Gets the Memstore flush size for the region that this store works with.
  - getFlushableSize
```
public long getFlushableSize()
```
    指定者:
    
    getFlushableSize 在接口中 Store
    
    返回:
    The amount of memory we could flush from this memstore; usually this is equal to Store.getMemStoreSize() unless we are carrying snapshots and then it will be the size of outstanding snapshots.
  - getSnapshotSize
```
public long getSnapshotSize()
```
    从接口复制的说明: Store
    
    Returns the memstore snapshot size
    
    指定者:
    
    getSnapshotSize 在接口中 Store
    
    返回:
    size of the memstore snapshot
  - getCompactionCheckMultiplier
```
public long getCompactionCheckMultiplier()
```
    指定者:
    
    getCompactionCheckMultiplier 在接口中 StoreConfigInformation
    
    返回:
    Gets the cf-specific compaction check frequency multiplier. The need for compaction (outside of normal checks during flush, open, etc.) will be ascertained every multiplier * HConstants.THREAD_WAKE_FREQUENCY milliseconds.
  - getBlockingFileCount
```
public long getBlockingFileCount()
```
    从接口复制的说明: StoreConfigInformation
    
    The number of files required before flushes for this store will be blocked.
    
    指定者:
    
    getBlockingFileCount 在接口中 StoreConfigInformation
  - getBytesPerChecksum
```
public static int getBytesPerChecksum(org.apache.hadoop.conf.Configuration conf)
```
    Returns the configured bytesPerChecksum value.
    
    参数:
    conf - The configuration
    
    返回:
    The bytesPerChecksum that is set in the configuration
  - getChecksumType
```
public static ChecksumType getChecksumType(org.apache.hadoop.conf.Configuration conf)
```
    Returns the configured checksum algorithm.
    
    参数:
    conf - The configuration
    
    返回:
    The checksum algorithm that is set in the configuration
  - getCloseCheckInterval
```
public static int getCloseCheckInterval()
```
    返回:
    how many bytes to write between status checks
  - getFamily
```
public HColumnDescriptor getFamily()
```
    指定者:
    
    getFamily 在接口中 Store
  - getMaxSequenceId
```
public long getMaxSequenceId()
```
    指定者:
    
    getMaxSequenceId 在接口中 Store
    
    返回:
    The maximum sequence id in all store files. Used for log replay.
  - getMaxMemstoreTS
```
public long getMaxMemstoreTS()
```
    指定者:
    
    getMaxMemstoreTS 在接口中 Store
    
    返回:
    The maximum memstoreTS in all store files.
  - getStoreHomedir
```
@Deprecated
public static org.apache.hadoop.fs.Path getStoreHomedir(org.apache.hadoop.fs.Path tabledir,
                                                   HRegionInfo hri,
                                                   byte[] family)
```
    已过时。
    
    参数:
    tabledir - Path to where the table is being stored
    hri - HRegionInfo for the region.
    family - HColumnDescriptor describing the column family
    
    返回:
    Path to family/Store home directory.
  - getStoreHomedir
```
@Deprecated
public static org.apache.hadoop.fs.Path getStoreHomedir(org.apache.hadoop.fs.Path tabledir,
                                                   String encodedName,
                                                   byte[] family)
```
    已过时。
    
    参数:
    tabledir - Path to where the table is being stored
    encodedName - Encoded region name.
    family - HColumnDescriptor describing the column family
    
    返回:
    Path to family/Store home directory.
  - getDataBlockEncoder
```
public HFileDataBlockEncoder getDataBlockEncoder()
```
    指定者:
    
    getDataBlockEncoder 在接口中 Store
    
    返回:
    the data block encoder
  - refreshStoreFiles
```
public void refreshStoreFiles()
                       throws IOException
```
    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. Mainly used by secondary region replicas to keep up to date with the primary region files.
    
    指定者:
    
    refreshStoreFiles 在接口中 Store
    
    抛出:
    
    IOException
  - refreshStoreFiles
```
public void refreshStoreFiles(Collection<String> newFiles)
                       throws IOException
```
    从接口复制的说明: Store
    
    Replaces the store files that the store has with the given files. Mainly used by secondary region replicas to keep up to date with the primary region files.
    
    指定者:
    
    refreshStoreFiles 在接口中 Store
    
    抛出:
    
    IOException
  - add
```
public long add(Cell cell)
```
    从接口复制的说明: Store
    
    Adds a value to the memstore
    
    指定者:
    
    add 在接口中 Store
    
    返回:
    memstore size delta
  - add
```
public long add(Iterable<Cell> cells)
```
    从接口复制的说明: Store
    
    Adds the specified value to the memstore
    
    指定者:
    
    add 在接口中 Store
    
    返回:
    memstore size delta
  - timeOfOldestEdit
```
public long timeOfOldestEdit()
```
    从接口复制的说明: Store
    
    When was the last edit done in the memstore
    
    指定者:
    
    timeOfOldestEdit 在接口中 Store
  - delete
```
protected long delete(KeyValue kv)
```
    Adds a value to the memstore
    
    参数:
    kv -
    
    返回:
    memstore size delta
  - rollback
```
public void rollback(Cell cell)
```
    从接口复制的说明: Store
    
    Removes a Cell from the memstore. The Cell is removed only if its key & memstoreTS match the key & memstoreTS value of the cell parameter.
    
    指定者:
    
    rollback 在接口中 Store
  - getStorefiles
```
public Collection<StoreFile> getStorefiles()
```
    指定者:
    
    getStorefiles 在接口中 Store
    
    返回:
    All store files.
  - getCompactedfiles
```
public Collection<StoreFile> getCompactedfiles()
```
  - assertBulkLoadHFileOk
```
public void assertBulkLoadHFileOk(org.apache.hadoop.fs.Path srcPath)
                           throws IOException
```
    从接口复制的说明: Store
    
    This throws a WrongRegionException if the HFile does not fit in this region, or an InvalidHFileException if the HFile is not valid.
    
    指定者:
    
    assertBulkLoadHFileOk 在接口中 Store
    
    抛出:
    
    IOException
  - preBulkLoadHFile
```
public Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path> preBulkLoadHFile(String srcPathStr,
                                                                         long seqNum)
                                                                           throws IOException
```
    抛出:
    
    IOException
  - bulkLoadHFile
```
public org.apache.hadoop.fs.Path bulkLoadHFile(byte[] family,
                                      String srcPathStr,
                                      org.apache.hadoop.fs.Path dstPath)
                                        throws IOException
```
    从接口复制的说明: Store
    
    This method should only be called from Region. It is assumed that the ranges of values in the HFile fit within the stores assigned region. (assertBulkLoadHFileOk checks this)
    
    指定者:
    
    bulkLoadHFile 在接口中 Store
    
    参数:
    family - the column family
    
    抛出:
    
    IOException
  - bulkLoadHFile
```
public void bulkLoadHFile(StoreFileInfo fileInfo)
                   throws IOException
```
    指定者:
    
    bulkLoadHFile 在接口中 Store
    
    抛出:
    
    IOException
  - close
```
public com.google.common.collect.ImmutableCollection<StoreFile> close()
                                                               throws IOException
```
    从接口复制的说明: Store
    
    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.
    
    指定者:
    
    close 在接口中 Store
    
    返回:
    the StoreFiles that were previously being used.
    
    抛出:
    
    IOException - on failure
  - flushCache
```
protected List<org.apache.hadoop.fs.Path> flushCache(long logCacheFlushId,
                                         MemStoreSnapshot snapshot,
                                         MonitoredTask status,
                                         ThroughputController throughputController)
                                              throws IOException
```
    Write out current snapshot. Presumes snapshot() has been called previously.
    
    参数:
    logCacheFlushId - flush sequence number
    snapshot -
    status -
    throughputController -
    
    返回:
    The path name of the tmp file to which the store was flushed
    
    抛出:
    
    IOException - if exception occurs during process
  - createWriterInTmp
```
public StoreFile.Writer createWriterInTmp(long maxKeyCount,
                                 Compression.Algorithm compression,
                                 boolean isCompaction,
                                 boolean includeMVCCReadpoint,
                                 boolean includesTag)
                                   throws IOException
```
    指定者:
    
    createWriterInTmp 在接口中 Store
    
    compression - Compression algorithm to use
    isCompaction - whether we are creating a new file in a compaction
    includeMVCCReadpoint - whether we should out the MVCC readpoint
    
    返回:
    Writer for a new StoreFile in the tmp dir.
    
    抛出:
    
    IOException
  - createWriterInTmp
```
public StoreFile.Writer createWriterInTmp(long maxKeyCount,
                                 Compression.Algorithm compression,
                                 boolean isCompaction,
                                 boolean includeMVCCReadpoint,
                                 boolean includesTag,
                                 boolean shouldDropBehind)
                                   throws IOException
```
    指定者:
    
    createWriterInTmp 在接口中 Store
    
    compression - Compression algorithm to use
    isCompaction - whether we are creating a new file in a compaction
    includeMVCCReadpoint - whether we should out the MVCC readpoint
    shouldDropBehind - should the writer drop caches behind writes
    
    返回:
    Writer for a new StoreFile in the tmp dir.
    
    抛出:
    
    IOException
  - createWriterInTmp
```
public StoreFile.Writer createWriterInTmp(long maxKeyCount,
                                 Compression.Algorithm compression,
                                 boolean isCompaction,
                                 boolean includeMVCCReadpoint,
                                 boolean includesTag,
                                 boolean shouldDropBehind,
                                 TimeRangeTracker trt)
                                   throws IOException
```
    指定者:
    
    createWriterInTmp 在接口中 Store
    
    compression - Compression algorithm to use
    isCompaction - whether we are creating a new file in a compaction
    includeMVCCReadpoint - whether we should out the MVCC readpoint
    shouldDropBehind - should the writer drop caches behind writes
    trt - Ready-made timetracker to use.
    
    返回:
    Writer for a new StoreFile in the tmp dir.
    
    抛出:
    
    IOException
  - getScanners
```
public List<KeyValueScanner> getScanners(boolean cacheBlocks,
                                boolean isGet,
                                boolean usePread,
                                boolean isCompaction,
                                ScanQueryMatcher matcher,
                                byte[] startRow,
                                byte[] stopRow,
                                long readPt)
                                  throws IOException
```
    Get all scanners with no filtering based on TTL (that happens further down the line).
    
    指定者:
    
    getScanners 在接口中 Store
    
    返回:
    all scanners for this store
    
    抛出:
    
    IOException
  - getScanners
```
public List<KeyValueScanner> getScanners(List<StoreFile> files,
                                boolean cacheBlocks,
                                boolean isGet,
                                boolean usePread,
                                boolean isCompaction,
                                ScanQueryMatcher matcher,
                                byte[] startRow,
                                byte[] stopRow,
                                long readPt,
                                boolean includeMemstoreScanner)
                                  throws IOException
```
    从接口复制的说明: Store
    
    Create scanners on the given files and if needed on the memstore with no filtering based on TTL (that happens further down the line).
    
    指定者:
    
    getScanners 在接口中 Store
    
    参数:
    files - the list of files on which the scanners has to be created
    cacheBlocks - cache the blocks or not
    isGet - true if it is get, false if not
    usePread - true to use pread, false if not
    isCompaction - true if the scanner is created for compaction
    matcher - the scan query matcher
    startRow - the start row
    stopRow - the stop row
    readPt - the read point of the current scan
    includeMemstoreScanner - true if memstore has to be included
    
    返回:
    scanners on the given files and on the memstore if specified
    
    抛出:
    
    IOException
  - addChangedReaderObserver
```
public void addChangedReaderObserver(ChangedReadersObserver o)
```
    指定者:
    
    addChangedReaderObserver 在接口中 Store
  - deleteChangedReaderObserver
```
public void deleteChangedReaderObserver(ChangedReadersObserver o)
```
    指定者:
    
    deleteChangedReaderObserver 在接口中 Store
  - compact
```
public List<StoreFile> compact(CompactionContext compaction,
                      ThroughputController throughputController)
                        throws IOException
```
    Compact the StoreFiles. This method may take some time, so the calling thread must be able to block for long periods.
    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 sync() 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.
    
    指定者:
    
    compact 在接口中 Store
    
    参数:
    compaction - compaction details obtained from requestCompaction()
    
    返回:
    Storefile we compacted into or null if we failed or opted out early.
    
    抛出:
    
    IOException
  - compact
```
public List<StoreFile> compact(CompactionContext compaction,
                      ThroughputController throughputController,
                      User user)
                        throws IOException
```
    指定者:
    
    compact 在接口中 Store
    
    抛出:
    
    IOException
  - replayCompactionMarker
```
public void replayCompactionMarker(org.apache.hadoop.hbase.protobuf.generated.WALProtos.CompactionDescriptor compaction,
                          boolean pickCompactionFiles,
                          boolean removeFiles)
                            throws IOException
```
    Call to complete a compaction. Its for the case where we find in the WAL a compaction that was not finished. We could find one recovering a WAL after a regionserver crash. See HBASE-2231.
    
    指定者:
    
    replayCompactionMarker 在接口中 Store
    
    参数:
    compaction -
    pickCompactionFiles - whether or not pick up the new compaction output files and add it to the store
    removeFiles - whether to remove/archive files from filesystem
    
    抛出:
    
    IOException
  - compactRecentForTestingAssumingDefaultPolicy
```
public void compactRecentForTestingAssumingDefaultPolicy(int N)
                                                  throws IOException
```
    This method tries to compact N recent files for testing. Note that because compacting "recent" files only makes sense for some policies, e.g. the default one, it assumes default policy is used. It doesn't use policy, but instead makes a compaction candidate list by itself.
    
    参数:
    N - Number of files.
    
    抛出:
    
    IOException
  - hasReferences
```
public boolean hasReferences()
```
    指定者:
    
    hasReferences 在接口中 Store
    
    返回:
    true if the store has any underlying reference files to older HFiles
  - getCompactionProgress
```
public CompactionProgress getCompactionProgress()
```
    从接口复制的说明: Store
    
    getter for CompactionProgress object
    
    指定者:
    
    getCompactionProgress 在接口中 Store
    
    返回:
    CompactionProgress object; can be null
  - isMajorCompaction
```
public boolean isMajorCompaction()
                          throws IOException
```
    指定者:
    
    isMajorCompaction 在接口中 Store
    
    返回:
    true if we should run a major compaction.
    
    抛出:
    
    IOException
  - requestCompaction
```
public CompactionContext requestCompaction()
                                    throws IOException
```
    指定者:
    
    requestCompaction 在接口中 Store
    
    抛出:
    
    IOException
  - requestCompaction
```
public CompactionContext requestCompaction(int priority,
                                  CompactionRequest baseRequest)
                                    throws IOException
```
    指定者:
    
    requestCompaction 在接口中 Store
    
    抛出:
    
    IOException
  - requestCompaction
```
public CompactionContext requestCompaction(int priority,
                                  CompactionRequest baseRequest,
                                  User user)
                                    throws IOException
```
    指定者:
    
    requestCompaction 在接口中 Store
    
    抛出:
    
    IOException
  - cancelRequestedCompaction
```
public void cancelRequestedCompaction(CompactionContext compaction)
```
    指定者:
    
    cancelRequestedCompaction 在接口中 Store
  - completeCompaction
```
protected void completeCompaction(Collection<StoreFile> compactedFiles)
                           throws 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 compacted
    
    抛出:
    
    IOException
  - completeCompaction
```
protected void completeCompaction(Collection<StoreFile> compactedFiles,
                      boolean removeFiles)
                           throws 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 compacted
    
    抛出:
    
    IOException
  - isCellTTLExpired
```
public static boolean isCellTTLExpired(Cell cell,
                       long oldestTimestamp,
                       long now)
```
    参数:
    cell -
    oldestTimestamp -
    
    返回:
    true if the cell is expired
  - getRowKeyAtOrBefore
```
public Cell getRowKeyAtOrBefore(byte[] row)
                         throws IOException
```
    从接口复制的说明: Store
    
    Find the key that matches row exactly, or the one that immediately precedes it. WARNING: Only use this method on a table where writes occur with strictly increasing timestamps. This method assumes this pattern of writes in order to make it reasonably performant. Also our search is dependent on the axiom that deletes are for cells that are in the container that follows whether a memstore snapshot or a storefile, not for the current container: i.e. we'll see deletes before we come across cells we are to delete. Presumption is that the memstore#kvset is processed before memstore#snapshot and so on.
    
    指定者:
    
    getRowKeyAtOrBefore 在接口中 Store
    
    参数:
    row - The row key of the targeted row.
    
    返回:
    Found Cell or null if none found.
    
    抛出:
    
    IOException
  - canSplit
```
public boolean canSplit()
```
    指定者:
    
    canSplit 在接口中 Store
  - getSplitPoint
```
public byte[] getSplitPoint()
```
    从接口复制的说明: Store
    
    Determines if Store should be split
    
    指定者:
    
    getSplitPoint 在接口中 Store
    
    返回:
    byte[] if store should be split, null otherwise.
  - getLastCompactSize
```
public long getLastCompactSize()
```
    指定者:
    
    getLastCompactSize 在接口中 Store
    
    返回:
    aggregate size of all HStores used in the last compaction
  - getSize
```
public long getSize()
```
    指定者:
    
    getSize 在接口中 Store
    
    返回:
    aggregate size of HStore
  - triggerMajorCompaction
```
public void triggerMajorCompaction()
```
    指定者:
    
    triggerMajorCompaction 在接口中 Store
  - getScanner
```
public KeyValueScanner getScanner(Scan scan,
                         NavigableSet<byte[]> targetCols,
                         long readPt)
                           throws IOException
```
    从接口复制的说明: Store
    
    Return a scanner for both the memstore and the HStore files. Assumes we are not in a compaction.
    
    指定者:
    
    getScanner 在接口中 Store
    
    参数:
    scan - Scan to apply when scanning the stores
    targetCols - columns to scan
    
    返回:
    a scanner over the current key values
    
    抛出:
    
    IOException - on failure
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - getStorefilesCount
```
public int getStorefilesCount()
```
    指定者:
    
    getStorefilesCount 在接口中 Store
    
    返回:
    Count of store files
  - getMaxStoreFileAge
```
public long getMaxStoreFileAge()
```
    指定者:
    
    getMaxStoreFileAge 在接口中 Store
    
    返回:
    Max age of store files in this store
  - getMinStoreFileAge
```
public long getMinStoreFileAge()
```
    指定者:
    
    getMinStoreFileAge 在接口中 Store
    
    返回:
    Min age of store files in this store
  - getAvgStoreFileAge
```
public long getAvgStoreFileAge()
```
    指定者:
    
    getAvgStoreFileAge 在接口中 Store
    
    返回:
    Average age of store files in this store, 0 if no store files
  - getNumReferenceFiles
```
public long getNumReferenceFiles()
```
    指定者:
    
    getNumReferenceFiles 在接口中 Store
    
    返回:
    Number of reference files in this store
  - getNumHFiles
```
public long getNumHFiles()
```
    指定者:
    
    getNumHFiles 在接口中 Store
    
    返回:
    Number of HFiles in this store
  - getStoreSizeUncompressed
```
public long getStoreSizeUncompressed()
```
    指定者:
    
    getStoreSizeUncompressed 在接口中 Store
    
    返回:
    The size of the store files, in bytes, uncompressed.
  - getStorefilesSize
```
public long getStorefilesSize()
```
    指定者:
    
    getStorefilesSize 在接口中 Store
    
    返回:
    The size of the store files, in bytes.
  - getStorefilesIndexSize
```
public long getStorefilesIndexSize()
```
    指定者:
    
    getStorefilesIndexSize 在接口中 Store
    
    返回:
    The size of the store file indexes, in bytes.
  - getTotalStaticIndexSize
```
public long getTotalStaticIndexSize()
```
    从接口复制的说明: Store
    
    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.
    
    指定者:
    
    getTotalStaticIndexSize 在接口中 Store
    
    返回:
    the total size of block indexes in the store
  - getTotalStaticBloomSize
```
public long getTotalStaticBloomSize()
```
    从接口复制的说明: Store
    
    Returns the total byte size of all Bloom filter bit arrays. For compound Bloom filters even the Bloom blocks currently not loaded into the block cache are counted.
    
    指定者:
    
    getTotalStaticBloomSize 在接口中 Store
    
    返回:
    the total size of all Bloom filters in the store
  - getMemStoreSize
```
public long getMemStoreSize()
```
    指定者:
    
    getMemStoreSize 在接口中 Store
    
    返回:
    The size of this store's memstore, in bytes
  - getCompactPriority
```
public int getCompactPriority()
```
    指定者:
    
    getCompactPriority 在接口中 Store
  - throttleCompaction
```
public boolean throttleCompaction(long compactionSize)
```
    指定者:
    
    throttleCompaction 在接口中 Store
  - getHRegion
```
public HRegion getHRegion()
```
  - getCoprocessorHost
```
public RegionCoprocessorHost getCoprocessorHost()
```
    指定者:
    
    getCoprocessorHost 在接口中 Store
  - getRegionInfo
```
public HRegionInfo getRegionInfo()
```
    指定者:
    
    getRegionInfo 在接口中 Store
    
    返回:
    the parent region info hosting this store
  - areWritesEnabled
```
public boolean areWritesEnabled()
```
    指定者:
    
    areWritesEnabled 在接口中 Store
  - getSmallestReadPoint
```
public long getSmallestReadPoint()
```
    指定者:
    
    getSmallestReadPoint 在接口中 Store
    
    返回:
    The smallest mvcc readPoint across all the scanners in this region. Writes older than this readPoint, are included in every read operation.
  - updateColumnValue
```
public long updateColumnValue(byte[] row,
                     byte[] f,
                     byte[] qualifier,
                     long newValue)
                       throws IOException
```
    Used in tests. TODO: Remove Updates the value for the given row/family/qualifier. This function will always be seen as atomic by other readers because it only puts a single KV to memstore. Thus no read/write control necessary.
    
    参数:
    row - row to update
    f - family to update
    qualifier - qualifier to update
    newValue - the new value to set into memstore
    
    返回:
    memstore size delta
    
    抛出:
    
    IOException
  - upsert
```
public long upsert(Iterable<Cell> cells,
          long readpoint,
          List<Cell> removedCells)
            throws IOException
```
    从接口复制的说明: Store
    
    Adds or replaces the specified KeyValues.
    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.
    
    指定者:
    
    upsert 在接口中 Store
    
    readpoint - readpoint below which we can safely remove duplicate KVs
    removedCells - collect the removed cells. It can be null.
    
    返回:
    memstore size delta
    
    抛出:
    
    IOException
  - createFlushContext
```
public org.apache.hadoop.hbase.regionserver.StoreFlushContext createFlushContext(long cacheFlushId)
```
    指定者:
    
    createFlushContext 在接口中 Store
  - needsCompaction
```
public boolean needsCompaction()
```
    从接口复制的说明: Store
    
    See if there's too much store files in this store
    
    指定者:
    
    needsCompaction 在接口中 Store
    
    返回:
    true if number of store files is greater than the number defined in minFilesToCompact
  - getCacheConfig
```
public CacheConfig getCacheConfig()
```
    从接口复制的说明: Store
    
    Used for tests.
    
    指定者:
    
    getCacheConfig 在接口中 Store
    
    返回:
    cache configuration for this Store.
  - heapSize
```
public long heapSize()
```
    指定者:
    
    heapSize 在接口中 HeapSize
  - getComparator
```
public KeyValue.KVComparator getComparator()
```
    指定者:
    
    getComparator 在接口中 Store
  - getScanInfo
```
public ScanInfo getScanInfo()
```
    指定者:
    
    getScanInfo 在接口中 Store
  - hasTooManyStoreFiles
```
public boolean hasTooManyStoreFiles()
```
    指定者:
    
    hasTooManyStoreFiles 在接口中 Store
    
    返回:
    Whether this store has too many store files.
  - getFlushedCellsCount
```
public long getFlushedCellsCount()
```
    指定者:
    
    getFlushedCellsCount 在接口中 Store
    
    返回:
    The number of cells flushed to disk
  - getFlushedCellsSize
```
public long getFlushedCellsSize()
```
    指定者:
    
    getFlushedCellsSize 在接口中 Store
    
    返回:
    The total size of data flushed to disk, in bytes
  - getFlushedOutputFileSize
```
public long getFlushedOutputFileSize()
```
    指定者:
    
    getFlushedOutputFileSize 在接口中 Store
    
    返回:
    The total size of out output files on disk, in bytes
  - getCompactedCellsCount
```
public long getCompactedCellsCount()
```
    指定者:
    
    getCompactedCellsCount 在接口中 Store
    
    返回:
    The number of cells processed during minor compactions
  - getCompactedCellsSize
```
public long getCompactedCellsSize()
```
    指定者:
    
    getCompactedCellsSize 在接口中 Store
    
    返回:
    The total amount of data processed during minor compactions, in bytes
  - getMajorCompactedCellsCount
```
public long getMajorCompactedCellsCount()
```
    指定者:
    
    getMajorCompactedCellsCount 在接口中 Store
    
    返回:
    The number of cells processed during major compactions
  - getMajorCompactedCellsSize
```
public long getMajorCompactedCellsSize()
```
    指定者:
    
    getMajorCompactedCellsSize 在接口中 Store
    
    返回:
    The total amount of data processed during major compactions, in bytes
  - getStoreEngine
```
public StoreEngine<?,?,?,?> getStoreEngine()
```
    Returns the StoreEngine that is backing this concrete implementation of Store.
    
    返回:
    Returns the StoreEngine object used internally inside this HStore object.
  - getOffPeakHours
```
protected OffPeakHours getOffPeakHours()
```
  - onConfigurationChange
```
public void onConfigurationChange(org.apache.hadoop.conf.Configuration conf)
```
    This method would be called by the ConfigurationManager object when the Configuration object is reloaded from disk.
    
    指定者:
    
    onConfigurationChange 在接口中 ConfigurationObserver
  - registerChildren
```
public void registerChildren(ConfigurationManager manager)
```
    Needs to be called to register the children to the manager.
    
    指定者:
    
    registerChildren 在接口中 PropagatingConfigurationObserver
    
    参数:
    manager - : to register to
  - deregisterChildren
```
public void deregisterChildren(ConfigurationManager manager)
```
    Needs to be called to deregister the children from the manager.
    
    指定者:
    
    deregisterChildren 在接口中 PropagatingConfigurationObserver
    
    参数:
    manager - : to deregister from
  - getCompactionPressure
```
public double getCompactionPressure()
```
    从接口复制的说明: Store
    This value can represent the degree of emergency of compaction for this store. It should be greater than or equal to 0.0, any value greater than 1.0 means we have too many store files.
    - if getStorefilesCount <= getMinFilesToCompact, return 0.0
    - return (getStorefilesCount - getMinFilesToCompact) / (blockingFileCount - getMinFilesToCompact)
    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 在接口中 Store
  - isPrimaryReplicaStore
```
public boolean isPrimaryReplicaStore()
```
    指定者:
    
    isPrimaryReplicaStore 在接口中 Store
  - preSnapshotOperation
```
public void preSnapshotOperation()
```
    Sets the store up for a region level snapshot operation.
    
    另请参阅:
    postSnapshotOperation()
  - postSnapshotOperation
```
public void postSnapshotOperation()
```
    Perform tasks needed after the completion of snapshot operation.
    
    另请参阅:
    preSnapshotOperation()
  - closeAndArchiveCompactedFiles
```
public void closeAndArchiveCompactedFiles()
                                   throws IOException
```
    从接口复制的说明: Store
    
    Closes and archives the compacted files under this store
    
    指定者:
    
    closeAndArchiveCompactedFiles 在接口中 Store
    
    抛出:
    
    IOException

类 HStore

字段概要

从接口继承的字段 org.apache.hadoop.hbase.regionserver.Store

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

COMPACTCHECKER_INTERVAL_MULTIPLIER_KEY

BLOCKING_STOREFILES_KEY

DEFAULT_COMPACTCHECKER_INTERVAL_MULTIPLIER

DEFAULT_BLOCKING_STOREFILE_COUNT

memstore

FIXED_OVERHEAD

DEEP_OVERHEAD

构造器详细资料

HStore

方法详细资料

getColumnFamilyName

getTableName

getFileSystem

getRegionFileSystem

getStoreFileTtl

getMemstoreFlushSize

getFlushableSize

getSnapshotSize

getCompactionCheckMultiplier

getBlockingFileCount

getBytesPerChecksum

getChecksumType

getCloseCheckInterval

getFamily

getMaxSequenceId

getMaxMemstoreTS

getStoreHomedir

getStoreHomedir

getDataBlockEncoder

refreshStoreFiles

refreshStoreFiles

add

add

timeOfOldestEdit

delete

rollback

getStorefiles

getCompactedfiles

assertBulkLoadHFileOk

preBulkLoadHFile

bulkLoadHFile

bulkLoadHFile

close

flushCache

createWriterInTmp

createWriterInTmp

createWriterInTmp

getScanners

getScanners

addChangedReaderObserver

deleteChangedReaderObserver

compact

compact

replayCompactionMarker

compactRecentForTestingAssumingDefaultPolicy

hasReferences

getCompactionProgress

isMajorCompaction

requestCompaction

requestCompaction

requestCompaction

cancelRequestedCompaction

completeCompaction

completeCompaction

isCellTTLExpired

getRowKeyAtOrBefore

canSplit

getSplitPoint

getLastCompactSize

getSize

triggerMajorCompaction

getScanner

toString