Package org.apache.hadoop.hbase.wal

Class WALKeyImpl

java.lang.Object

org.apache.hadoop.hbase.wal.WALKeyImpl

All Implemented Interfaces:

Comparable<WALKey>, SequenceId, WALKey

@LimitedPrivate("Replication")
public class WALKeyImpl
extends Object
implements WALKey

Default implementation of Key for an Entry in the WAL. For internal use only though Replication needs to have access. 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	Description
private List<UUID>	clusterIds	The first element in the list is the cluster id on which the change has originated
static final WALKeyImpl	EMPTY_WALKEYIMPL
private byte[]	encodedRegionName
private Map<String,byte[]>	extendedAttributes
private MultiVersionConcurrencyControl	mvcc
private long	nonce
private long	nonceGroup
private long	origLogSeqNum	Used during WAL replay; the sequenceId of the edit when it came into the system.
private NavigableMap<byte[],Integer>	replicationScope
private long	sequenceId	SequenceId for this edit.
private TableName	tablename
private MultiVersionConcurrencyControl.WriteEntry	writeEntry	Set in a way visible to multiple threads; e.g.
private long	writeTime	Time at which this edit was written.

Fields inherited from interface org.apache.hadoop.hbase.regionserver.SequenceId

NO_SEQUENCE_ID

Fields inherited from interface org.apache.hadoop.hbase.wal.WALKey

EMPTY_UUIDS

Constructor Summary

Constructors

Constructor	Description
WALKeyImpl()
WALKeyImpl(byte[] encodedRegionName, TableName tablename, long now)
WALKeyImpl(byte[] encodedRegionName, TableName tablename, long logSeqNum, long nonceGroup, long nonce, MultiVersionConcurrencyControl mvcc)	Create the log key for writing to somewhere.
WALKeyImpl(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.
WALKeyImpl(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.
WALKeyImpl(byte[] encodedRegionName, TableName tablename, long logSeqNum, long now, UUID clusterId)
WALKeyImpl(byte[] encodedRegionName, TableName tablename, long now, List<UUID> clusterIds, long nonceGroup, long nonce, MultiVersionConcurrencyControl mvcc)	Create the log key for writing to somewhere.
WALKeyImpl(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.
WALKeyImpl(byte[] encodedRegionName, TableName tablename, long now, List<UUID> clusterIds, long nonceGroup, long nonce, MultiVersionConcurrencyControl mvcc, NavigableMap<byte[],Integer> replicationScope, Map<String,byte[]> extendedAttributes)
WALKeyImpl(byte[] encodedRegionName, TableName tablename, long now, NavigableMap<byte[],Integer> replicationScope)
WALKeyImpl(byte[] encodedRegionName, TableName tablename, long now, MultiVersionConcurrencyControl mvcc)
WALKeyImpl(byte[] encodedRegionName, TableName tablename, long now, MultiVersionConcurrencyControl mvcc, NavigableMap<byte[],Integer> replicationScope)
WALKeyImpl(byte[] encodedRegionName, TableName tablename, long now, MultiVersionConcurrencyControl mvcc, NavigableMap<byte[],Integer> replicationScope, Map<String,byte[]> extendedAttributes)
WALKeyImpl(NavigableMap<byte[],Integer> replicationScope)
WALKeyImpl(WALKeyImpl key, Map<String,byte[]> extendedAttributes)	Copy constructor that takes in an existing WALKeyImpl plus some extended attributes.
WALKeyImpl(WALKey key, List<UUID> clusterIds, MultiVersionConcurrencyControl mvcc, NavigableMap<byte[],Integer> replicationScopes, Map<String,byte[]> extendedAttributes)	Copy constructor that takes in an existing WALKey, the extra WALKeyImpl fields that the parent interface is missing, plus some extended attributes.

Method Summary

Modifier and Type	Method	Description
void	addClusterId(UUID clusterId)	Marks that the cluster with the given clusterId has consumed the change
void	addExtendedAttribute(String attributeKey, byte[] attributeValue)	Add a named String value to this WALKey to be persisted into the WAL
void	clearReplicationScope()
int	compareTo(WALKey o)
boolean	equals(Object obj)
long	estimatedSerializedSizeOf()
org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALKey.Builder	getBuilder(WALCellCodec.ByteStringCompressor compressor)
List<UUID>	getClusterIds()	Returns the set of cluster Ids that have consumed the change
byte[]	getEncodedRegionName()	Returns encoded region name
byte[]	getExtendedAttribute(String attributeKey)	Return a named String value injected into the WALKey during processing, such as by a coprocessor
Map<String,byte[]>	getExtendedAttributes()	Returns a map of all extended attributes injected into this WAL key.
long	getLogSeqNum()	Deprecated. Use getSequenceId()
MultiVersionConcurrencyControl	getMvcc()
long	getNonce()	Returns The nonce
long	getNonceGroup()	Returns The nonce group
UUID	getOriginatingClusterId()
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.
NavigableMap<byte[],Integer>	getReplicationScopes()
long	getSequenceId()	SequenceId is only available post WAL-assign.
TableName	getTableName()	Returns table name
MultiVersionConcurrencyControl.WriteEntry	getWriteEntry()	Use it to complete mvcc transaction.
long	getWriteTime()	Returns the write time
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, Map<String,byte[]> extendedAttributes)
(package private) void	internEncodedRegionName(byte[] encodedRegionName)	Drop this instance's region name byte array and instead hold a reference to the provided region name.
(package private) void	internTableName(TableName tablename)	Drop this instance's tablename byte array and instead hold a reference to the provided tablename.
void	readFieldsFromPb(org.apache.hadoop.hbase.shaded.protobuf.generated.WALProtos.WALKey walKey, WALCellCodec.ByteStringUncompressor uncompressor)
void	setCompressionContext(CompressionContext compressionContext)	Deprecated. deparcated since hbase 2.1.0
void	setOrigLogSeqNum(long sequenceId)	Used to set original sequenceId for WALKeyImpl during WAL replay
private void	setReplicationScope(NavigableMap<byte[],Integer> replicationScope)
protected void	setSequenceId(long sequenceId)
void	setWriteEntry(MultiVersionConcurrencyControl.WriteEntry writeEntry)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.wal.WALKey

toStringMap

Field Details

EMPTY_WALKEYIMPL

public static final WALKeyImpl EMPTY_WALKEYIMPL

encodedRegionName

private byte[] encodedRegionName

tablename

private TableName tablename

sequenceId

private long sequenceId

SequenceId for this edit. Set post-construction at write-to-WAL time. Until then it is NO_SEQUENCE_ID. Change it so multiple threads can read it -- e.g. access is synchronized.

origLogSeqNum

private long origLogSeqNum

Used during WAL replay; the sequenceId of the edit when it came into the system.

writeTime

private long writeTime

Time at which this edit was written.

clusterIds

private List<UUID> clusterIds

The first element in the list is the cluster id on which the change has originated

replicationScope

private NavigableMap<byte[],Integer> replicationScope

nonceGroup

private long nonceGroup

nonce

private long nonce

mvcc

private MultiVersionConcurrencyControl mvcc

writeEntry

private MultiVersionConcurrencyControl.WriteEntry writeEntry

Set in a way visible to multiple threads; e.g. synchronized getter/setters.

extendedAttributes

private Map<String,byte[]> extendedAttributes

Constructor Details

WALKeyImpl

public WALKeyImpl()

WALKeyImpl

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

WALKeyImpl

@Private
public WALKeyImpl(byte[] encodedRegionName,
 TableName tablename,
 long logSeqNum,
 long now,
 UUID clusterId)

WALKeyImpl

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

WALKeyImpl

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

WALKeyImpl

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

WALKeyImpl

public WALKeyImpl(byte[] encodedRegionName,
 TableName tablename,
 long now,
 MultiVersionConcurrencyControl mvcc,
 NavigableMap<byte[],Integer> replicationScope,
 Map<String,byte[]> extendedAttributes)

WALKeyImpl

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

WALKeyImpl

public WALKeyImpl(WALKeyImpl key,
 Map<String,byte[]> extendedAttributes)

Copy constructor that takes in an existing WALKeyImpl plus some extended attributes. Intended for coprocessors to add annotations to a system-generated WALKey for persistence to the WAL.

Parameters:

key - Key to be copied into this new key

extendedAttributes - Extra attributes to copy into the new key

WALKeyImpl

public WALKeyImpl(WALKey key,
 List<UUID> clusterIds,
 MultiVersionConcurrencyControl mvcc,
 NavigableMap<byte[],Integer> replicationScopes,
 Map<String,byte[]> extendedAttributes)

Copy constructor that takes in an existing WALKey, the extra WALKeyImpl fields that the parent interface is missing, plus some extended attributes. Intended for coprocessors to add annotations to a system-generated WALKey for persistence to the WAL.

WALKeyImpl

public WALKeyImpl(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 WALKeyImpl

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

WALKeyImpl

public WALKeyImpl(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)

WALKeyImpl

public WALKeyImpl(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)

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

WALKeyImpl

public WALKeyImpl(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().

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

WALKeyImpl

public WALKeyImpl(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().

WALKeyImpl

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

Method Details

getMvcc

public MultiVersionConcurrencyControl getMvcc()

getWriteEntry

public MultiVersionConcurrencyControl.WriteEntry getWriteEntry()

Use it to complete mvcc transaction. This WALKeyImpl 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.

See Also:

• setWriteEntry(MultiVersionConcurrencyControl.WriteEntry)

setWriteEntry

public void setWriteEntry(MultiVersionConcurrencyControl.WriteEntry writeEntry)

init

@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,
 Map<String,byte[]> extendedAttributes)

setSequenceId

@Private
protected void setSequenceId(long sequenceId)

setCompressionContext

@Deprecated
public void setCompressionContext(CompressionContext compressionContext)

Deprecated.

deparcated since hbase 2.1.0

Parameters:

compressionContext - Compression context to use

getEncodedRegionName

public byte[] getEncodedRegionName()

Returns encoded region name

Specified by:

getEncodedRegionName in interface WALKey

getTableName

public TableName getTableName()

Returns table name

Specified by:

getTableName in interface WALKey

getLogSeqNum

@Deprecated
public long getLogSeqNum()

Deprecated.

Use getSequenceId()

Returns:

log sequence number

setOrigLogSeqNum

public void setOrigLogSeqNum(long sequenceId)

Used to set original sequenceId for WALKeyImpl during WAL replay

getOrigLogSeqNum

public 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.

Specified by:

getOrigLogSeqNum in interface WALKey

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 SequenceId.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

Specified by:

getWriteTime in interface WALKey

getReplicationScopes

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

getNonceGroup

public long getNonceGroup()

Returns The nonce group

Specified by:

getNonceGroup in interface WALKey

getNonce

public long getNonce()

Returns The nonce

Specified by:

getNonce in interface WALKey

setReplicationScope

private void setReplicationScope(NavigableMap<byte[],Integer> replicationScope)

clearReplicationScope

public void clearReplicationScope()

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()

Specified by:

getOriginatingClusterId in interface WALKey

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)

addExtendedAttribute

public void addExtendedAttribute(String attributeKey,
 byte[] attributeValue)

Description copied from interface: WALKey

Add a named String value to this WALKey to be persisted into the WAL

Specified by:

addExtendedAttribute in interface WALKey

Parameters:

attributeKey - Name of the attribute

attributeValue - Value of the attribute

getExtendedAttribute

public byte[] getExtendedAttribute(String attributeKey)

Description copied from interface: WALKey

Return a named String value injected into the WALKey during processing, such as by a coprocessor

Specified by:

getExtendedAttribute in interface WALKey

Parameters:

attributeKey - The key of a key / value pair

getExtendedAttributes

public Map<String,byte[]> getExtendedAttributes()

Description copied from interface: WALKey

Returns a map of all extended attributes injected into this WAL key.

Specified by:

getExtendedAttributes in interface WALKey

toString

public String toString()

Overrides:

toString in class Object

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>

internTableName

void internTableName(TableName tablename)

Drop this instance's tablename byte array and instead hold a reference to the provided tablename. This is not meant to be a general purpose setter - it's only used to collapse references to conserve memory.

internEncodedRegionName

void internEncodedRegionName(byte[] encodedRegionName)

Drop this instance's region name byte array and instead hold a reference to the provided region name. This is not meant to be a general purpose setter - it's only used to collapse references to conserve memory.

getBuilder

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

Throws:

IOException

readFieldsFromPb

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

Throws:

IOException

estimatedSerializedSizeOf

public long estimatedSerializedSizeOf()

Specified by:

estimatedSerializedSizeOf in interface WALKey