ReplicationAdmin (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.client.replication.ReplicationAdmin

All Implemented Interfaces:

Closeable, AutoCloseable
```
@InterfaceAudience.Public
@InterfaceStability.Evolving
public class ReplicationAdmin
extends Object
implements Closeable
```
This class provides the administrative interface to HBase cluster replication. In order to use it, the cluster and the client using ReplicationAdmin must be configured with hbase.replication set to true.

Adding a new peer results in creating new outbound connections from every region server to a subset of region servers on the slave cluster. Each new stream of replication will start replicating from the beginning of the current WAL, meaning that edits from that past will be replicated.

Removing a peer is a destructive and irreversible operation that stops all the replication streams for the given cluster and deletes the metadata used to keep track of the replication state.

To see which commands are available in the shell, type replication.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CFNAME`
`private Connection`	`connection`
`private static org.apache.commons.logging.Log`	`LOG`
`static String`	`REPLICATIONGLOBAL`
`private ReplicationPeers`	`replicationPeers`
`private ReplicationQueuesClient`	`replicationQueuesClient`
`static String`	`REPLICATIONTYPE`
`static String`	`TNAME`
`private ZooKeeperWatcher`	`zkw` A watcher used by replicationPeers and replicationQueuesClient.

Constructor Summary

Constructors
Constructor and Description

ReplicationAdmin(org.apache.hadoop.conf.Configuration conf)
Constructor that creates a connection to the local ZooKeeper ensemble.

Constructors
Constructor and Description
`ReplicationAdmin(org.apache.hadoop.conf.Configuration conf)` Constructor that creates a connection to the local ZooKeeper ensemble.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addPeer(String id, ReplicationPeerConfig peerConfig, Map<TableName,? extends Collection<String>> tableCfs)` Add a new remote slave cluster for replication.
`void`	`addPeer(String id, String clusterKey)` Deprecated. Use addPeer(String, ReplicationPeerConfig, Map) instead.
`void`	`addPeer(String id, String clusterKey, String tableCFs)` Deprecated.
`void`	`appendPeerTableCFs(String id, Map<TableName,? extends Collection<String>> tableCfs)` Append the replicable table-cf config of the specified peer
`void`	`appendPeerTableCFs(String id, String tableCfs)` Append the replicable table-cf config of the specified peer
`private void`	`checkAndSyncTableDescToPeers(TableName tableName, byte[][] splits)` Connect to peer and check the table descriptor on peer: Create the same table on peer when not exist. Throw exception if the table exists on peer cluster but descriptors are not same.
`void`	`close()`
`private ZooKeeperWatcher`	`createZooKeeperWatcher()`
`void`	`disablePeer(String id)` Stop the replication stream to the specified peer.
`void`	`disableTableRep(TableName tableName)` Disable a table's replication switch.
`void`	`enablePeer(String id)` Restart the replication stream to the specified peer.
`void`	`enableTableRep(TableName tableName)` Enable a table's replication switch.
`ReplicationPeerConfig`	`getPeerConfig(String id)`
`int`	`getPeersCount()` Get the number of slave clusters the local cluster has.
`boolean`	`getPeerState(String id)` Get the state of the specified peer cluster
`String`	`getPeerTableCFs(String id)` Get the replicable table-cf config of the specified peer.
`(package private) static String`	`getTableCfsStr(Map<TableName,? extends Collection<String>> tableCfs)`
`private byte[][]`	`getTableSplitRowKeys(TableName tableName)` Get the split row keys of table
`private boolean`	`isTableRepEnabled(HTableDescriptor htd)`
`Map<String,ReplicationPeerConfig>`	`listPeerConfigs()`
`Map<String,String>`	`listPeers()` Deprecated. use `listPeerConfigs()`
`List<HashMap<String,String>>`	`listReplicated()` Find all column families that are replicated from this cluster
`(package private) List<ReplicationPeer>`	`listReplicationPeers()`
`static Map<TableName,List<String>>`	`parseTableCFsFromConfig(String tableCFsConfig)`
`void`	`removePeer(String id)` Removes a peer cluster and stops the replication to it.
`void`	`removePeerTableCFs(String id, Map<TableName,? extends Collection<String>> tableCfs)` Remove some table-cfs from config of the specified peer
`void`	`removePeerTableCFs(String id, String tableCf)` Remove some table-cfs from table-cfs config of the specified peer
`void`	`setPeerTableCFs(String id, Map<TableName,? extends Collection<String>> tableCfs)` Set the replicable table-cf config of the specified peer
`void`	`setPeerTableCFs(String id, String tableCFs)` Deprecated. use `setPeerTableCFs(String, Map)`
`private void`	`setTableRep(TableName tableName, boolean isRepEnabled)` Set the table's replication switch if the table's replication switch is already not set.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOG
```
private static final org.apache.commons.logging.Log LOG
```
  - TNAME
```
public static final String TNAME
```
    See Also:
    Constant Field Values
  - CFNAME
```
public static final String CFNAME
```
    See Also:
    Constant Field Values
  - REPLICATIONTYPE
```
public static final String REPLICATIONTYPE
```
    See Also:
    Constant Field Values
  - REPLICATIONGLOBAL
```
public static final String REPLICATIONGLOBAL
```
  - connection
```
private final Connection connection
```
  - replicationQueuesClient
```
private final ReplicationQueuesClient replicationQueuesClient
```
  - replicationPeers
```
private final ReplicationPeers replicationPeers
```
  - zkw
```
private final ZooKeeperWatcher zkw
```
    A watcher used by replicationPeers and replicationQueuesClient. Keep reference so can dispose on close().
- Constructor Detail
  - ReplicationAdmin
```
public ReplicationAdmin(org.apache.hadoop.conf.Configuration conf)
                 throws IOException
```
    Constructor that creates a connection to the local ZooKeeper ensemble.
    
    Parameters:
    conf - Configuration to use
    
    Throws:
    
    IOException - if an internal replication error occurs
    
    RuntimeException - if replication isn't enabled.
- Method Detail
  - createZooKeeperWatcher
```
private ZooKeeperWatcher createZooKeeperWatcher()
                                         throws IOException
```
    Throws:
    
    IOException
  - addPeer
```
@Deprecated
public void addPeer(String id,
                      String clusterKey)
             throws ReplicationException
```
    Deprecated. Use addPeer(String, ReplicationPeerConfig, Map) instead.
    
    Add a new peer cluster to replicate to.
    
    Parameters:
    id - a short name that identifies the cluster
    clusterKey - the concatenation of the slave cluster's hbase.zookeeper.quorum:hbase.zookeeper.property.clientPort:zookeeper.znode.parent
    
    Throws:
    
    IllegalStateException - if there's already one slave since multi-slave isn't supported yet.
    
    ReplicationException
  - addPeer
```
@Deprecated
public void addPeer(String id,
                      String clusterKey,
                      String tableCFs)
             throws ReplicationException
```
    Deprecated.
    
    Throws:
    
    ReplicationException
  - addPeer
```
public void addPeer(String id,
           ReplicationPeerConfig peerConfig,
           Map<TableName,? extends Collection<String>> tableCfs)
             throws ReplicationException
```
    Add a new remote slave cluster for replication.
    
    Parameters:
    id - a short name that identifies the cluster
    peerConfig - configuration for the replication slave cluster
    tableCfs - the table and column-family list which will be replicated for this peer. A map from tableName to column family names. An empty collection can be passed to indicate replicating all column families. Pass null for replicating all table and column families
    
    Throws:
    
    ReplicationException
  - parseTableCFsFromConfig
```
public static Map<TableName,List<String>> parseTableCFsFromConfig(String tableCFsConfig)
```
  - getTableCfsStr
```
static String getTableCfsStr(Map<TableName,? extends Collection<String>> tableCfs)
```
  - removePeer
```
public void removePeer(String id)
                throws ReplicationException
```
    Removes a peer cluster and stops the replication to it.
    
    Parameters:
    id - a short name that identifies the cluster
    
    Throws:
    
    ReplicationException
  - enablePeer
```
public void enablePeer(String id)
                throws ReplicationException
```
    Restart the replication stream to the specified peer.
    
    Parameters:
    id - a short name that identifies the cluster
    
    Throws:
    
    ReplicationException
  - disablePeer
```
public void disablePeer(String id)
                 throws ReplicationException
```
    Stop the replication stream to the specified peer.
    
    Parameters:
    id - a short name that identifies the cluster
    
    Throws:
    
    ReplicationException
  - getPeersCount
```
public int getPeersCount()
```
    Get the number of slave clusters the local cluster has.
    
    Returns:
    number of slave clusters
  - listPeers
```
@Deprecated
public Map<String,String> listPeers()
```
    Deprecated. use listPeerConfigs()
    
    Map of this cluster's peers for display.
    
    Returns:
    A map of peer ids to peer cluster keys
  - listPeerConfigs
```
public Map<String,ReplicationPeerConfig> listPeerConfigs()
```
  - getPeerConfig
```
public ReplicationPeerConfig getPeerConfig(String id)
                                    throws ReplicationException
```
    Throws:
    
    ReplicationException
  - getPeerTableCFs
```
public String getPeerTableCFs(String id)
                       throws ReplicationException
```
    Get the replicable table-cf config of the specified peer.
    
    Parameters:
    id - a short name that identifies the cluster
    
    Throws:
    
    ReplicationException
  - setPeerTableCFs
```
@Deprecated
public void setPeerTableCFs(String id,
                              String tableCFs)
                     throws ReplicationException
```
    Deprecated. use setPeerTableCFs(String, Map)
    
    Set the replicable table-cf config of the specified peer
    
    Parameters:
    id - a short name that identifies the cluster
    
    Throws:
    
    ReplicationException
  - appendPeerTableCFs
```
public void appendPeerTableCFs(String id,
                      String tableCfs)
                        throws ReplicationException
```
    Append the replicable table-cf config of the specified peer
    
    Parameters:
    id - a short that identifies the cluster
    tableCfs - table-cfs config str
    
    Throws:
    
    ReplicationException
  - appendPeerTableCFs
```
public void appendPeerTableCFs(String id,
                      Map<TableName,? extends Collection<String>> tableCfs)
                        throws ReplicationException
```
    Append the replicable table-cf config of the specified peer
    
    Parameters:
    id - a short that identifies the cluster
    tableCfs - A map from tableName to column family names
    
    Throws:
    
    ReplicationException
  - removePeerTableCFs
```
public void removePeerTableCFs(String id,
                      String tableCf)
                        throws ReplicationException
```
    Remove some table-cfs from table-cfs config of the specified peer
    
    Parameters:
    id - a short name that identifies the cluster
    tableCf - table-cfs config str
    
    Throws:
    
    ReplicationException
  - removePeerTableCFs
```
public void removePeerTableCFs(String id,
                      Map<TableName,? extends Collection<String>> tableCfs)
                        throws ReplicationException
```
    Remove some table-cfs from config of the specified peer
    
    Parameters:
    id - a short name that identifies the cluster
    tableCfs - A map from tableName to column family names
    
    Throws:
    
    ReplicationException
  - setPeerTableCFs
```
public void setPeerTableCFs(String id,
                   Map<TableName,? extends Collection<String>> tableCfs)
                     throws ReplicationException
```
    Set the replicable table-cf config of the specified peer
    
    Parameters:
    id - a short name that identifies the cluster
    tableCfs - the table and column-family list which will be replicated for this peer. A map from tableName to column family names. An empty collection can be passed to indicate replicating all column families. Pass null for replicating all table and column families
    
    Throws:
    
    ReplicationException
  - getPeerState
```
public boolean getPeerState(String id)
                     throws ReplicationException
```
    Get the state of the specified peer cluster
    
    Parameters:
    id - String format of the Short name that identifies the peer, an IllegalArgumentException is thrown if it doesn't exist
    
    Returns:
    true if replication is enabled to that peer, false if it isn't
    
    Throws:
    
    ReplicationException
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException
  - listReplicated
```
public List<HashMap<String,String>> listReplicated()
                                            throws IOException
```
    Find all column families that are replicated from this cluster
    
    Returns:
    the full list of the replicated column families of this cluster as: tableName, family name, replicationType Currently replicationType is Global. In the future, more replication types may be extended here. For example 1) the replication may only apply to selected peers instead of all peers 2) the replicationType may indicate the host Cluster servers as Slave for the table:columnFam.
    
    Throws:
    
    IOException
  - enableTableRep
```
public void enableTableRep(TableName tableName)
                    throws IOException
```
    Enable a table's replication switch.
    
    Parameters:
    tableName - name of the table
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - disableTableRep
```
public void disableTableRep(TableName tableName)
                     throws IOException
```
    Disable a table's replication switch.
    
    Parameters:
    tableName - name of the table
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getTableSplitRowKeys
```
private byte[][] getTableSplitRowKeys(TableName tableName)
                               throws IOException
```
    Get the split row keys of table
    
    Parameters:
    tableName - table name
    
    Returns:
    array of split row keys
    
    Throws:
    
    IOException
  - checkAndSyncTableDescToPeers
```
private void checkAndSyncTableDescToPeers(TableName tableName,
                                byte[][] splits)
                                   throws IOException
```
    Connect to peer and check the table descriptor on peer:
    1. Create the same table on peer when not exist.
    2. Throw exception if the table exists on peer cluster but descriptors are not same.
    Parameters:
    tableName - name of the table to sync to the peer
    splits - table split keys
    
    Throws:
    
    IOException
  - listReplicationPeers
```
List<ReplicationPeer> listReplicationPeers()
```
  - setTableRep
```
private void setTableRep(TableName tableName,
               boolean isRepEnabled)
                  throws IOException
```
    Set the table's replication switch if the table's replication switch is already not set.
    
    Parameters:
    tableName - name of the table
    isRepEnabled - is replication switch enable or disable
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - isTableRepEnabled
```
private boolean isTableRepEnabled(HTableDescriptor htd)
```
    Parameters:
    htd - table descriptor details for the table to check
    
    Returns:
    true if table's replication switch is enabled

Class ReplicationAdmin

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

TNAME

CFNAME

REPLICATIONTYPE

REPLICATIONGLOBAL

connection

replicationQueuesClient

replicationPeers

zkw

Constructor Detail

ReplicationAdmin

Method Detail

createZooKeeperWatcher

addPeer

addPeer

addPeer

parseTableCFsFromConfig

getTableCfsStr

removePeer

enablePeer

disablePeer

getPeersCount

listPeers

listPeerConfigs

getPeerConfig

getPeerTableCFs

setPeerTableCFs

appendPeerTableCFs

appendPeerTableCFs

removePeerTableCFs

removePeerTableCFs

setPeerTableCFs

getPeerState

close

listReplicated

enableTableRep

disableTableRep

getTableSplitRowKeys

checkAndSyncTableDescToPeers

listReplicationPeers

setTableRep

isTableRepEnabled