org.apache.hadoop.hbase.wal

Class WALKey

java.lang.Object

org.apache.hadoop.hbase.wal.WALKey

All Implemented Interfaces:

Comparable<WALKey>, SequenceId

@InterfaceAudience.Private
public class WALKey
extends Object
implements SequenceId, Comparable<WALKey>

A Key for an entry in the WAL. The log intermingles edits to many tables and rows, so each log entry identifies the appropriate table and row. Within a table and row, they're also sorted.

Some Transactional edits (START, COMMIT, ABORT) will not have an associated row.

Field Summary

Fields

Modifier and Type	Field and Description
static List<UUID>	EMPTY_UUIDS
static long	NO_SEQUENCE_ID Used to represent when a particular wal key doesn't know/care about the sequence ordering.

Constructor Summary

Constructors

Constructor and Description
WALKey()
WALKey(byte[] encodedRegionName, TableName tablename, long now)
WALKey(byte[] encodedRegionName, TableName tablename, long now, List<UUID> clusterIds, long nonceGroup, long nonce, MultiVersionConcurrencyControl mvcc) Create the log key for writing to somewhere.
WALKey(byte[] encodedRegionName, TableName tablename, long now, List<UUID> clusterIds, long nonceGroup, long nonce, MultiVersionConcurrencyControl mvcc, NavigableMap<byte[],Integer> replicationScope) Create the log key for writing to somewhere.
WALKey(byte[] encodedRegionName, TableName tablename, long logSeqNum, long now, List<UUID> clusterIds, long nonceGroup, long nonce, MultiVersionConcurrencyControl mvcc) Create the log key for writing to somewhere.
WALKey(byte[] encodedRegionName, TableName tablename, long logSeqNum, long now, List<UUID> clusterIds, long nonceGroup, long nonce, MultiVersionConcurrencyControl mvcc, NavigableMap<byte[],Integer> replicationScope) Create the log key for writing to somewhere.
WALKey(byte[] encodedRegionName, TableName tablename, long logSeqNum, long nonceGroup, long nonce, MultiVersionConcurrencyControl mvcc) Create the log key for writing to somewhere.
WALKey(byte[] encodedRegionName, TableName tablename, long logSeqNum, long now, UUID clusterId)
WALKey(byte[] encodedRegionName, TableName tablename, long now, MultiVersionConcurrencyControl mvcc)
WALKey(byte[] encodedRegionName, TableName tablename, long now, MultiVersionConcurrencyControl mvcc, NavigableMap<byte[],Integer> replicationScope)
WALKey(byte[] encodedRegionName, TableName tablename, long now, NavigableMap<byte[],Integer> replicationScope)
WALKey(NavigableMap<byte[],Integer> replicationScope)

Method Summary

Modifier and Type	Method and Description
void	addClusterId(UUID clusterId) Marks that the cluster with the given clusterId has consumed the change
int	compareTo(WALKey o)
boolean	equals(Object obj)
long	estimatedSerializedSizeOf()
org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALEdit.Builder	getBuilder(WALCellCodec.ByteStringCompressor compressor)
List<UUID>	getClusterIds()
byte[]	getEncodedRegionName()
long	getLogSeqNum() Deprecated. Use getSequenceId()
MultiVersionConcurrencyControl	getMvcc()
long	getNonce()
long	getNonceGroup()
UUID	getOriginatingClusterId()
long	getOrigLogSeqNum() Return a positive long if current WALKey is created from a replay edit; a replay edit is an edit that came in when replaying WALs of a crashed server.
NavigableMap<byte[],Integer>	getReplicationScopes()
long	getSequenceId() SequenceId is only available post WAL-assign.
TableName	getTablename()
MultiVersionConcurrencyControl.WriteEntry	getWriteEntry() Use it to complete mvcc transaction.
long	getWriteTime()
int	hashCode()
protected void	init(byte[] encodedRegionName, TableName tablename, long logSeqNum, long now, List<UUID> clusterIds, long nonceGroup, long nonce, MultiVersionConcurrencyControl mvcc, NavigableMap<byte[],Integer> replicationScope)
void	readFieldsFromPb(org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALEdit walEdit, WALCellCodec.ByteStringUncompressor uncompressor)
void	serializeReplicationScope(boolean serialize)
void	setCompressionContext(CompressionContext compressionContext)
void	setOrigLogSeqNum(long sequenceId) Used to set original sequenceId for WALKey during WAL replay
protected void	setSequenceId(long sequenceId)
void	setWriteEntry(MultiVersionConcurrencyControl.WriteEntry writeEntry)
String	toString()
Map<String,Object>	toStringMap() Produces a string map for this key.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_SEQUENCE_ID

public static final long NO_SEQUENCE_ID

Used to represent when a particular wal key doesn't know/care about the sequence ordering.

See Also:

Constant Field Values

EMPTY_UUIDS

public static final List<UUID> EMPTY_UUIDS

Constructor Detail

WALKey

public WALKey()

WALKey

public WALKey(NavigableMap<byte[],Integer> replicationScope)

WALKey

public WALKey(byte[] encodedRegionName,
              TableName tablename,
              long logSeqNum,
              long now,
              UUID clusterId)

WALKey

public WALKey(byte[] encodedRegionName,
              TableName tablename,
              long now)

WALKey

public WALKey(byte[] encodedRegionName,
              TableName tablename,
              long now,
              NavigableMap<byte[],Integer> replicationScope)

WALKey

public WALKey(byte[] encodedRegionName,
              TableName tablename,
              long now,
              MultiVersionConcurrencyControl mvcc,
              NavigableMap<byte[],Integer> replicationScope)

WALKey

public WALKey(byte[] encodedRegionName,
              TableName tablename,
              long now,
              MultiVersionConcurrencyControl mvcc)

WALKey

public WALKey(byte[] encodedRegionName,
              TableName tablename,
              long logSeqNum,
              long now,
              List<UUID> clusterIds,
              long nonceGroup,
              long nonce,
              MultiVersionConcurrencyControl mvcc,
              NavigableMap<byte[],Integer> replicationScope)

Create the log key for writing to somewhere. We maintain the tablename mainly for debugging purposes. A regionName is always a sub-table object.

Used by log splitting and snapshots.

Parameters:

encodedRegionName - Encoded name of the region as returned by HRegionInfo#getEncodedNameAsBytes().

tablename - - name of table

logSeqNum - - log sequence number

now - Time at which this edit was written.

clusterIds - the clusters that have consumed the change(used in Replication)

nonceGroup - the nonceGroup

nonce - the nonce

mvcc - the mvcc associate the WALKey

replicationScope - the non-default replication scope associated with the region's column families

WALKey

public WALKey(byte[] encodedRegionName,
              TableName tablename,
              long logSeqNum,
              long now,
              List<UUID> clusterIds,
              long nonceGroup,
              long nonce,
              MultiVersionConcurrencyControl mvcc)

Create the log key for writing to somewhere. We maintain the tablename mainly for debugging purposes. A regionName is always a sub-table object.

Used by log splitting and snapshots.

Parameters:

encodedRegionName - Encoded name of the region as returned by HRegionInfo#getEncodedNameAsBytes().

tablename - - name of table

logSeqNum - - log sequence number

now - Time at which this edit was written.

clusterIds - the clusters that have consumed the change(used in Replication)

WALKey

public WALKey(byte[] encodedRegionName,
              TableName tablename,
              long now,
              List<UUID> clusterIds,
              long nonceGroup,
              long nonce,
              MultiVersionConcurrencyControl mvcc)

Create the log key for writing to somewhere. We maintain the tablename mainly for debugging purposes. A regionName is always a sub-table object.

Parameters:

encodedRegionName - Encoded name of the region as returned by HRegionInfo#getEncodedNameAsBytes().

tablename - the tablename

now - Time at which this edit was written.

clusterIds - the clusters that have consumed the change(used in Replication)

nonceGroup -

nonce -

mvcc - mvcc control used to generate sequence numbers and control read/write points

WALKey

public WALKey(byte[] encodedRegionName,
              TableName tablename,
              long now,
              List<UUID> clusterIds,
              long nonceGroup,
              long nonce,
              MultiVersionConcurrencyControl mvcc,
              NavigableMap<byte[],Integer> replicationScope)

Create the log key for writing to somewhere. We maintain the tablename mainly for debugging purposes. A regionName is always a sub-table object.

Parameters:

encodedRegionName - Encoded name of the region as returned by HRegionInfo#getEncodedNameAsBytes().

tablename -

now - Time at which this edit was written.

clusterIds - the clusters that have consumed the change(used in Replication)

nonceGroup - the nonceGroup

nonce - the nonce

mvcc - mvcc control used to generate sequence numbers and control read/write points

replicationScope - the non-default replication scope of the column families

WALKey

public WALKey(byte[] encodedRegionName,
              TableName tablename,
              long logSeqNum,
              long nonceGroup,
              long nonce,
              MultiVersionConcurrencyControl mvcc)

Create the log key for writing to somewhere. We maintain the tablename mainly for debugging purposes. A regionName is always a sub-table object.

Parameters:

encodedRegionName - Encoded name of the region as returned by HRegionInfo#getEncodedNameAsBytes().

tablename -

logSeqNum -

nonceGroup -

nonce -

Method Detail

getMvcc

@InterfaceAudience.Private
public MultiVersionConcurrencyControl getMvcc()

getWriteEntry

@InterfaceAudience.Private
public MultiVersionConcurrencyControl.WriteEntry getWriteEntry()
                                                                                   throws InterruptedIOException

Use it to complete mvcc transaction. This WALKey was part of (the transaction is started when you call append; see the comment on FSHLog#append). To complete call MultiVersionConcurrencyControl.complete(MultiVersionConcurrencyControl.WriteEntry) or MultiVersionConcurrencyControl.complete(MultiVersionConcurrencyControl.WriteEntry)

Returns:

A WriteEntry gotten from local WAL subsystem.

Throws:

InterruptedIOException

See Also:

setWriteEntry(MultiVersionConcurrencyControl.WriteEntry)

setWriteEntry

@InterfaceAudience.Private
public void setWriteEntry(MultiVersionConcurrencyControl.WriteEntry writeEntry)

init

@InterfaceAudience.Private
protected void init(byte[] encodedRegionName,
                                               TableName tablename,
                                               long logSeqNum,
                                               long now,
                                               List<UUID> clusterIds,
                                               long nonceGroup,
                                               long nonce,
                                               MultiVersionConcurrencyControl mvcc,
                                               NavigableMap<byte[],Integer> replicationScope)

setSequenceId

@InterfaceAudience.Private
protected void setSequenceId(long sequenceId)

setCompressionContext

public void setCompressionContext(CompressionContext compressionContext)

Parameters:

compressionContext - Compression context to use

getEncodedRegionName

public byte[] getEncodedRegionName()

Returns:

encoded region name

getTablename

public TableName getTablename()

Returns:

table name

getLogSeqNum

@Deprecated
public long getLogSeqNum()

Deprecated. Use getSequenceId()

Returns:

log sequence number

setOrigLogSeqNum

public void setOrigLogSeqNum(long sequenceId)

Used to set original sequenceId for WALKey during WAL replay

getOrigLogSeqNum

public long getOrigLogSeqNum()

Return a positive long if current WALKey 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

getSequenceId

public long getSequenceId()

SequenceId is only available post WAL-assign. Calls before this will get you a NO_SEQUENCE_ID. See the comment on FSHLog#append and #getWriteNumber in this method for more on when this sequenceId comes available.

Specified by:

getSequenceId in interface SequenceId

Returns:

long the new assigned sequence number

getWriteTime

public long getWriteTime()

Returns:

the write time

getReplicationScopes

public NavigableMap<byte[],Integer> getReplicationScopes()

getNonceGroup

public long getNonceGroup()

Returns:

The nonce group

getNonce

public long getNonce()

Returns:

The nonce

serializeReplicationScope

public void serializeReplicationScope(boolean serialize)

addClusterId

public void addClusterId(UUID clusterId)

Marks that the cluster with the given clusterId has consumed the change

getClusterIds

public List<UUID> getClusterIds()

Returns:

the set of cluster Ids that have consumed the change

getOriginatingClusterId

public UUID getOriginatingClusterId()

Returns:

the cluster id on which the change has originated. It there is no such cluster, it returns DEFAULT_CLUSTER_ID (cases where replication is not enabled)

toString

public String toString()

Overrides:

toString in class Object

toStringMap

public Map<String,Object> toStringMap()

Produces a string map for this key. Useful for programmatic use and manipulation of the data stored in an WALKey, for example, printing as JSON.

Returns:

a Map containing data from this key

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(WALKey o)

Specified by:

compareTo in interface Comparable<WALKey>

getBuilder

public org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALEdit.Builder getBuilder(WALCellCodec.ByteStringCompressor compressor)
                                                                                       throws IOException

Throws:

IOException

readFieldsFromPb

public void readFieldsFromPb(org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALEdit walEdit,
                             WALCellCodec.ByteStringUncompressor uncompressor)
                      throws IOException

Throws:

IOException

estimatedSerializedSizeOf

public long estimatedSerializedSizeOf()