Package org.apache.hadoop.hbase.regionserver

Interface StoreFile

All Known Implementing Classes:
HStoreFile
@LimitedPrivate("Coprocesssor") @Evolving public interface StoreFile
An interface to describe a store data file.

NOTICE: this interface is mainly designed for coprocessor, so it will not expose all the internal APIs for a 'store file'. If you are implementing something inside HBase, i.e, not a coprocessor hook, usually you should use HStoreFile directly as it is the only implementation of this interface.

  • Method Details

    • getFirstKey

      Optional<ExtendedCell> getFirstKey()
      Get the first key in this store file.

    • getLastKey

      Optional<ExtendedCell> getLastKey()
      Get the last key in this store file.

    • getComparator

      CellComparator getComparator()
      Get the comparator for comparing two cells.

    • getMaxMemStoreTS

      long getMaxMemStoreTS()
      Get max of the MemstoreTS in the KV's in this store file.

    • getPath

      org.apache.hadoop.fs.Path getPath()
      Returns Path or null if this StoreFile was made with a Stream.

    • getEncodedPath

      org.apache.hadoop.fs.Path getEncodedPath()
      Returns Encoded Path if this StoreFile was made with a Stream.

    • getQualifiedPath

      org.apache.hadoop.fs.Path getQualifiedPath()
      Returns Returns the qualified path of this StoreFile

    • isReference

      boolean isReference()
      Returns True if this is a StoreFile Reference.

    • isHFile

      boolean isHFile()
      Returns True if this is HFile.

    • isMajorCompactionResult

      boolean isMajorCompactionResult()
      Returns True if this file was made by a major compaction.

    • excludeFromMinorCompaction

      boolean excludeFromMinorCompaction()
      Returns True if this file should not be part of a minor compaction.

    • getMaxSequenceId

      long getMaxSequenceId()
      Returns This files maximum edit sequence id.

    • getModificationTimestamp

      long getModificationTimestamp() throws IOException
      Get the modification time of this store file. Usually will access the file system so throws IOException.
      Throws:
      IOException

    • isBulkLoadResult

      boolean isBulkLoadResult()
      Check if this storefile was created by bulk load. When a hfile is bulk loaded into HBase, we append '_SeqId_<id-when-loaded>' to the hfile name, unless "hbase.mapreduce.bulkload.assign.sequenceNumbers" is explicitly turned off. If "hbase.mapreduce.bulkload.assign.sequenceNumbers" is turned off, fall back to BULKLOAD_TIME_KEY.
      Returns:
      true if this storefile was created by bulk load.

    • getBulkLoadTimestamp

      OptionalLong getBulkLoadTimestamp()
      Return the timestamp at which this bulk load file was generated.

    • toStringDetailed

      String toStringDetailed()
      Returns a length description of this StoreFile, suitable for debug output

    • getMinimumTimestamp

      OptionalLong getMinimumTimestamp()
      Get the min timestamp of all the cells in the store file.

    • getMaximumTimestamp

      OptionalLong getMaximumTimestamp()
      Get the max timestamp of all the cells in the store file.