Package org.apache.hadoop.hbase.wal

Interface WALKey

All Superinterfaces:
Comparable<WALKey>, SequenceId
All Known Implementing Classes:
WALKeyImpl
@LimitedPrivate({"Replication","Coprocesssor"}) public interface WALKey extends SequenceId, Comparable<WALKey>
Key for WAL Entry.

  • Field Details

  • Method Details

    • estimatedSerializedSizeOf

      default long estimatedSerializedSizeOf()

    • getEncodedRegionName

      byte[] getEncodedRegionName()
      Returns encoded region name

    • getTableName

      TableName getTableName()
      Returns table name

    • getWriteTime

      long getWriteTime()
      Returns the write time

    • getNonceGroup

      default long getNonceGroup()
      Returns The nonce group

    • getNonce

      default long getNonce()
      Returns The nonce

    • getOriginatingClusterId

      UUID getOriginatingClusterId()

    • getOrigLogSeqNum

      long getOrigLogSeqNum()
      Return a positive long if current WALKeyImpl is created from a replay edit; a replay edit is an edit that came in when replaying WALs of a crashed server.
      Returns:
      original sequence number of the WALEdit

    • addExtendedAttribute

      void addExtendedAttribute(String attributeKey, byte[] attributeValue)
      Add a named String value to this WALKey to be persisted into the WAL
      Parameters:
      attributeKey - Name of the attribute
      attributeValue - Value of the attribute

    • getExtendedAttribute

      default byte[] getExtendedAttribute(String attributeKey)
      Return a named String value injected into the WALKey during processing, such as by a coprocessor
      Parameters:
      attributeKey - The key of a key / value pair

    • getExtendedAttributes

      default Map<String,byte[]> getExtendedAttributes()
      Returns a map of all extended attributes injected into this WAL key.

    • toStringMap

      default Map<String,Object> toStringMap()
      Produces a string map for this key. Useful for programmatic use and manipulation of the data stored in an WALKeyImpl, for example, printing as JSON.
      Returns:
      a Map containing data from this key