org.apache.hadoop.hbase.client.replication

Class ReplicationAdmin

java.lang.Object

org.apache.hadoop.hbase.client.replication.ReplicationAdmin

All Implemented Interfaces:

Closeable, AutoCloseable

Deprecated.

use Admin instead.

@InterfaceAudience.Public
 @Deprecated
public class ReplicationAdmin
extends Object
implements Closeable

This class provides the administrative interface to HBase cluster replication.

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
private Admin	admin Deprecated.
static String	CFNAME Deprecated.
private Connection	connection Deprecated.
static String	REPLICATIONGLOBAL Deprecated.
static String	REPLICATIONTYPE Deprecated.
static String	TNAME Deprecated.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addPeer(String id, ReplicationPeerConfig peerConfig) Deprecated. use Admin.addReplicationPeer(String, ReplicationPeerConfig) instead
void	addPeer(String id, ReplicationPeerConfig peerConfig, Map<TableName,? extends Collection<String>> tableCfs) Deprecated. as release of 2.0.0, and it will be removed in 3.0.0, use addPeer(String, ReplicationPeerConfig) instead.
void	appendPeerTableCFs(String id, Map<TableName,? extends Collection<String>> tableCfs) Deprecated.
void	appendPeerTableCFs(String id, String tableCfs) Deprecated.
void	close() Deprecated.
private Map<TableName,List<String>>	copyTableCFs(Map<TableName,? extends Collection<String>> tableCfs) Deprecated.
void	disablePeer(String id) Deprecated. use Admin.disableReplicationPeer(String) instead
void	disableTableRep(TableName tableName) Deprecated. use Admin.disableTableReplication(TableName) instead
void	enablePeer(String id) Deprecated. use Admin.enableReplicationPeer(String) instead
void	enableTableRep(TableName tableName) Deprecated. use Admin.enableTableReplication(TableName) instead
ReplicationPeerConfig	getPeerConfig(String id) Deprecated. use Admin.getReplicationPeerConfig(String) instead
int	getPeersCount() Deprecated.
boolean	getPeerState(String id) Deprecated.
String	getPeerTableCFs(String id) Deprecated. as release of 2.0.0, and it will be removed in 3.0.0, use getPeerConfig(String) instead.
Map<String,ReplicationPeerConfig>	listPeerConfigs() Deprecated. use Admin.listReplicationPeers() instead
List<HashMap<String,String>>	listReplicated() Deprecated. use Admin.listReplicatedTableCFs() instead
(package private) List<ReplicationPeerDescription>	listReplicationPeers() Deprecated. use Admin.listReplicationPeers() instead
static Map<TableName,List<String>>	parseTableCFsFromConfig(String tableCFsConfig) Deprecated. as release of 2.0.0, and it will be removed in 3.0.0
void	removePeer(String id) Deprecated. use Admin.removeReplicationPeer(String) instead
void	removePeerTableCFs(String id, Map<TableName,? extends Collection<String>> tableCfs) Deprecated.
void	removePeerTableCFs(String id, String tableCf) Deprecated.
void	setPeerTableCFs(String id, Map<TableName,? extends Collection<String>> tableCfs) Deprecated.
void	updatePeerConfig(String id, ReplicationPeerConfig peerConfig) Deprecated. use Admin.updateReplicationPeerConfig(String, ReplicationPeerConfig) instead

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TNAME

public static final String TNAME

Deprecated.

See Also:

Constant Field Values

CFNAME

public static final String CFNAME

Deprecated.

See Also:

Constant Field Values

REPLICATIONTYPE

public static final String REPLICATIONTYPE

Deprecated.

See Also:

Constant Field Values

REPLICATIONGLOBAL

public static final String REPLICATIONGLOBAL

Deprecated.

connection

private final Connection connection

Deprecated.

admin

private Admin admin

Deprecated.

Constructor Detail

ReplicationAdmin

public ReplicationAdmin(org.apache.hadoop.conf.Configuration conf)
                 throws IOException

Deprecated.

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

addPeer

@Deprecated
public void addPeer(String id,
                                ReplicationPeerConfig peerConfig,
                                Map<TableName,? extends Collection<String>> tableCfs)
                         throws ReplicationException,
                                IOException

Deprecated. as release of 2.0.0, and it will be removed in 3.0.0, use addPeer(String, ReplicationPeerConfig) instead.

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

IOException

addPeer

@Deprecated
public void addPeer(String id,
                                ReplicationPeerConfig peerConfig)
                         throws ReplicationException,
                                IOException

Deprecated. use Admin.addReplicationPeer(String, ReplicationPeerConfig) instead

Add a new remote slave cluster for replication.

Parameters:

id - a short name that identifies the cluster

peerConfig - configuration for the replication slave cluster

Throws:

ReplicationException

IOException

parseTableCFsFromConfig

@Deprecated
public static Map<TableName,List<String>> parseTableCFsFromConfig(String tableCFsConfig)

Deprecated. as release of 2.0.0, and it will be removed in 3.0.0

updatePeerConfig

@Deprecated
public void updatePeerConfig(String id,
                                         ReplicationPeerConfig peerConfig)
                                  throws IOException

Deprecated. use Admin.updateReplicationPeerConfig(String, ReplicationPeerConfig) instead

Throws:

IOException

removePeer

@Deprecated
public void removePeer(String id)
                            throws IOException

Deprecated. use Admin.removeReplicationPeer(String) instead

Removes a peer cluster and stops the replication to it.

Parameters:

id - a short name that identifies the cluster

Throws:

IOException

enablePeer

@Deprecated
public void enablePeer(String id)
                            throws IOException

Deprecated. use Admin.enableReplicationPeer(String) instead

Restart the replication stream to the specified peer.

Parameters:

id - a short name that identifies the cluster

Throws:

IOException

disablePeer

@Deprecated
public void disablePeer(String id)
                             throws IOException

Deprecated. use Admin.disableReplicationPeer(String) instead

Stop the replication stream to the specified peer.

Parameters:

id - a short name that identifies the cluster

Throws:

IOException

getPeersCount

@Deprecated
public int getPeersCount()
                              throws IOException

Deprecated.

Get the number of slave clusters the local cluster has.

Returns:

number of slave clusters n * @deprecated

Throws:

IOException

listPeerConfigs

@Deprecated
public Map<String,ReplicationPeerConfig> listPeerConfigs()
                                                              throws IOException

Deprecated. use Admin.listReplicationPeers() instead

Throws:

IOException

getPeerConfig

@Deprecated
public ReplicationPeerConfig getPeerConfig(String id)
                                                throws IOException

Deprecated. use Admin.getReplicationPeerConfig(String) instead

Throws:

IOException

getPeerTableCFs

@Deprecated
public String getPeerTableCFs(String id)
                                   throws IOException

Deprecated. as release of 2.0.0, and it will be removed in 3.0.0, use getPeerConfig(String) instead.

Get the replicable table-cf config of the specified peer.

Parameters:

id - a short name that identifies the cluster

Throws:

IOException

appendPeerTableCFs

@Deprecated
public void appendPeerTableCFs(String id,
                                           String tableCfs)
                                    throws ReplicationException,
                                           IOException

Deprecated.

Append the replicable table-cf config of the specified peer

Parameters:

id - a short that identifies the cluster

tableCfs - table-cfs config str nn * @deprecated as release of 2.0.0, and it will be removed in 3.0.0, use appendPeerTableCFs(String, Map) instead.

Throws:

ReplicationException

IOException

appendPeerTableCFs

@Deprecated
public void appendPeerTableCFs(String id,
                                           Map<TableName,? extends Collection<String>> tableCfs)
                                    throws ReplicationException,
                                           IOException

Deprecated.

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 nn

Throws:

ReplicationException

IOException

removePeerTableCFs

@Deprecated
public void removePeerTableCFs(String id,
                                           String tableCf)
                                    throws ReplicationException,
                                           IOException

Deprecated.

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 nn * @deprecated as release of 2.0.0, and it will be removed in 3.0.0, use removePeerTableCFs(String, Map) instead.

Throws:

ReplicationException

IOException

removePeerTableCFs

@Deprecated
public void removePeerTableCFs(String id,
                                           Map<TableName,? extends Collection<String>> tableCfs)
                                    throws ReplicationException,
                                           IOException

Deprecated.

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 nn

Throws:

ReplicationException

IOException

copyTableCFs

private Map<TableName,List<String>> copyTableCFs(Map<TableName,? extends Collection<String>> tableCfs)

Deprecated.

setPeerTableCFs

@Deprecated
public void setPeerTableCFs(String id,
                                        Map<TableName,? extends Collection<String>> tableCfs)
                                 throws IOException

Deprecated.

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:

IOException

getPeerState

@Deprecated
public boolean getPeerState(String id)
                                 throws ReplicationException,
                                        IOException

Deprecated.

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

IOException

close

public void close()
           throws IOException

Deprecated.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

listReplicated

@Deprecated
public List<HashMap<String,String>> listReplicated()
                                                        throws IOException

Deprecated. use Admin.listReplicatedTableCFs() instead

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

@Deprecated
public void enableTableRep(TableName tableName)
                                throws IOException

Deprecated. use Admin.enableTableReplication(TableName) instead

Enable a table's replication switch.

Parameters:

tableName - name of the table

Throws:

IOException - if a remote or network exception occurs

disableTableRep

@Deprecated
public void disableTableRep(TableName tableName)
                                 throws IOException

Deprecated. use Admin.disableTableReplication(TableName) instead

Disable a table's replication switch.

Parameters:

tableName - name of the table

Throws:

IOException - if a remote or network exception occurs

listReplicationPeers

@InterfaceAudience.Private
 @Deprecated
List<ReplicationPeerDescription> listReplicationPeers()
                                                                                       throws IOException

Deprecated. use Admin.listReplicationPeers() instead

Throws:

IOException