org.apache.hadoop.hbase.replication

Interface ReplicationQueues

All Known Implementing Classes:

ReplicationQueuesZKImpl

@InterfaceAudience.Private
public interface ReplicationQueues

This provides an interface for maintaining a region server's replication queues. These queues keep track of the WALs and HFile references (if hbase.replication.bulkload.enabled is enabled) that still need to be replicated to remote clusters.

Method Summary

Modifier and Type	Method and Description
void	addHFileRefs(String peerId, List<Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path>> pairs) Add new hfile references to the queue.
void	addLog(String queueId, String filename) Add a new WAL file to the given queue.
void	addPeerToHFileRefs(String peerId) Add a peer to hfile reference queue if peer does not exist.
Pair<String,SortedSet<String>>	claimQueue(String regionserver, String queueId) Take ownership for the queue identified by queueId and belongs to a dead region server.
List<String>	getAllQueues() Get a list of all queues for this region server.
List<String>	getListOfReplicators() Get a list of all region servers that have outstanding replication queues.
long	getLogPosition(String queueId, String filename) Get the current position for a specific WAL in a given queue.
List<String>	getLogsInQueue(String queueId) Get a list of all WALs in the given queue.
List<String>	getUnClaimedQueueIds(String regionserver) Get queueIds from a dead region server, whose queues has not been claimed by other region servers.
void	init(String serverName) Initialize the region server replication queue interface.
boolean	isThisOurRegionServer(String regionserver) Checks if the provided znode is the same as this region server's
void	removeAllQueues() Remove all replication queues for this region server.
void	removeHFileRefs(String peerId, List<String> files) Remove hfile references from the queue.
void	removeLog(String queueId, String filename) Remove an WAL file from the given queue.
void	removePeerFromHFileRefs(String peerId) Remove a peer from hfile reference queue.
void	removeQueue(String queueId) Remove a replication queue.
void	removeReplicatorIfQueueIsEmpty(String regionserver) Remove the znode of region server if the queue is empty.
void	setLogPosition(String queueId, String filename, long position) Set the current position for a specific WAL in a given queue.

Method Detail

init

void init(String serverName)
   throws ReplicationException

Initialize the region server replication queue interface.

Parameters:

serverName - The server name of the region server that owns the replication queues this interface manages.

Throws:

ReplicationException

removeQueue

void removeQueue(String queueId)

Remove a replication queue.

Parameters:

queueId - a String that identifies the queue.

addLog

void addLog(String queueId,
            String filename)
     throws ReplicationException

Add a new WAL file to the given queue. If the queue does not exist it is created.

Parameters:

queueId - a String that identifies the queue.

filename - name of the WAL

Throws:

ReplicationException

removeLog

void removeLog(String queueId,
               String filename)

Remove an WAL file from the given queue.

Parameters:

queueId - a String that identifies the queue.

filename - name of the WAL

setLogPosition

void setLogPosition(String queueId,
                    String filename,
                    long position)

Set the current position for a specific WAL in a given queue.

Parameters:

queueId - a String that identifies the queue

filename - name of the WAL

position - the current position in the file

getLogPosition

long getLogPosition(String queueId,
                    String filename)
             throws ReplicationException

Get the current position for a specific WAL in a given queue.

Parameters:

queueId - a String that identifies the queue

filename - name of the WAL

Returns:

the current position in the file

Throws:

ReplicationException

removeAllQueues

void removeAllQueues()

Remove all replication queues for this region server.

getLogsInQueue

List<String> getLogsInQueue(String queueId)

Get a list of all WALs in the given queue.

Parameters:

queueId - a String that identifies the queue

Returns:

a list of WALs, null if no such queue exists for this server

getAllQueues

List<String> getAllQueues()

Get a list of all queues for this region server.

Returns:

a list of queueIds, an empty list if this region server is dead and has no outstanding queues

getUnClaimedQueueIds

List<String> getUnClaimedQueueIds(String regionserver)

Get queueIds from a dead region server, whose queues has not been claimed by other region servers.

Returns:

empty if the queue exists but no children, null if the queue does not exist.

claimQueue

Pair<String,SortedSet<String>> claimQueue(String regionserver,
                                          String queueId)

Take ownership for the queue identified by queueId and belongs to a dead region server.

Parameters:

regionserver - the id of the dead region server

queueId - the id of the queue

Returns:

the new PeerId and A SortedSet of WALs in its queue, and null if no unclaimed queue.

removeReplicatorIfQueueIsEmpty

void removeReplicatorIfQueueIsEmpty(String regionserver)

Remove the znode of region server if the queue is empty.

Parameters:

regionserver -

getListOfReplicators

List<String> getListOfReplicators()
                           throws ReplicationException

Get a list of all region servers that have outstanding replication queues. These servers could be alive, dead or from a previous run of the cluster.

Returns:

a list of server names

Throws:

ReplicationException

isThisOurRegionServer

boolean isThisOurRegionServer(String regionserver)

Checks if the provided znode is the same as this region server's

Parameters:

regionserver - the id of the region server

Returns:

if this is this rs's znode

addPeerToHFileRefs

void addPeerToHFileRefs(String peerId)
                 throws ReplicationException

Add a peer to hfile reference queue if peer does not exist.

Parameters:

peerId - peer cluster id to be added

Throws:

ReplicationException - if fails to add a peer id to hfile reference queue

removePeerFromHFileRefs

void removePeerFromHFileRefs(String peerId)

Remove a peer from hfile reference queue.

Parameters:

peerId - peer cluster id to be removed

addHFileRefs

void addHFileRefs(String peerId,
                  List<Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path>> pairs)
           throws ReplicationException

Add new hfile references to the queue.

Parameters:

peerId - peer cluster id to which the hfiles need to be replicated

pairs - list of pairs of { HFile location in staging dir, HFile path in region dir which will be added in the queue }

Throws:

ReplicationException - if fails to add a hfile reference

removeHFileRefs

void removeHFileRefs(String peerId,
                     List<String> files)

Remove hfile references from the queue.

Parameters:

peerId - peer cluster id from which this hfile references needs to be removed

files - list of hfile references to be removed