@InterfaceAudience.Public @InterfaceStability.Evolving public class ReplicationAdmin extends java.lang.Object implements java.io.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
.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFNAME |
static java.lang.String |
REPLICATIONGLOBAL |
static java.lang.String |
REPLICATIONTYPE |
static java.lang.String |
TNAME |
Constructor and Description |
---|
ReplicationAdmin(Configuration conf)
Constructor that creates a connection to the local ZooKeeper ensemble.
|
Modifier and Type | Method and Description |
---|---|
void |
addPeer(java.lang.String id,
ReplicationPeerConfig peerConfig,
java.util.Map<TableName,? extends java.util.Collection<java.lang.String>> tableCfs)
Add a new remote slave cluster for replication.
|
void |
addPeer(java.lang.String id,
java.lang.String clusterKey)
Deprecated.
Use addPeer(String, ReplicationPeerConfig, Map) instead.
|
void |
addPeer(java.lang.String id,
java.lang.String clusterKey,
java.lang.String tableCFs)
Deprecated.
|
void |
appendPeerTableCFs(java.lang.String id,
java.util.Map<TableName,? extends java.util.Collection<java.lang.String>> tableCfs)
Append the replicable table-cf config of the specified peer
|
void |
appendPeerTableCFs(java.lang.String id,
java.lang.String tableCfs)
Append the replicable table-cf config of the specified peer
|
void |
close() |
void |
disablePeer(java.lang.String id)
Stop the replication stream to the specified peer.
|
void |
disableTableRep(TableName tableName)
Disable a table's replication switch.
|
void |
enablePeer(java.lang.String id)
Restart the replication stream to the specified peer.
|
void |
enableTableRep(TableName tableName)
Enable a table's replication switch.
|
ReplicationPeerConfig |
getPeerConfig(java.lang.String id) |
int |
getPeersCount()
Get the number of slave clusters the local cluster has.
|
boolean |
getPeerState(java.lang.String id)
Get the state of the specified peer cluster
|
java.lang.String |
getPeerTableCFs(java.lang.String id)
Get the replicable table-cf config of the specified peer.
|
java.util.Map<java.lang.String,ReplicationPeerConfig> |
listPeerConfigs() |
java.util.Map<java.lang.String,java.lang.String> |
listPeers()
Deprecated.
|
java.util.List<java.util.HashMap<java.lang.String,java.lang.String>> |
listReplicated()
Find all column families that are replicated from this cluster
|
static java.util.Map<TableName,java.util.List<java.lang.String>> |
parseTableCFsFromConfig(java.lang.String tableCFsConfig) |
void |
removePeer(java.lang.String id)
Removes a peer cluster and stops the replication to it.
|
void |
removePeerTableCFs(java.lang.String id,
java.util.Map<TableName,? extends java.util.Collection<java.lang.String>> tableCfs)
Remove some table-cfs from config of the specified peer
|
void |
removePeerTableCFs(java.lang.String id,
java.lang.String tableCf)
Remove some table-cfs from table-cfs config of the specified peer
|
void |
setPeerTableCFs(java.lang.String id,
java.util.Map<TableName,? extends java.util.Collection<java.lang.String>> tableCfs)
Set the replicable table-cf config of the specified peer
|
void |
setPeerTableCFs(java.lang.String id,
java.lang.String tableCFs)
Deprecated.
|
public static final java.lang.String TNAME
public static final java.lang.String CFNAME
public static final java.lang.String REPLICATIONTYPE
public static final java.lang.String REPLICATIONGLOBAL
public ReplicationAdmin(Configuration conf) throws java.io.IOException
conf
- Configuration to usejava.io.IOException
- if an internal replication error occursjava.lang.RuntimeException
- if replication isn't enabled.@Deprecated public void addPeer(java.lang.String id, java.lang.String clusterKey) throws ReplicationException
id
- a short name that identifies the clusterclusterKey
- the concatenation of the slave cluster's
hbase.zookeeper.quorum:hbase.zookeeper.property.clientPort:zookeeper.znode.parent
java.lang.IllegalStateException
- if there's already one slave since
multi-slave isn't supported yet.ReplicationException
@Deprecated public void addPeer(java.lang.String id, java.lang.String clusterKey, java.lang.String tableCFs) throws ReplicationException
ReplicationException
public void addPeer(java.lang.String id, ReplicationPeerConfig peerConfig, java.util.Map<TableName,? extends java.util.Collection<java.lang.String>> tableCfs) throws ReplicationException
id
- a short name that identifies the clusterpeerConfig
- configuration for the replication slave clustertableCfs
- 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
familiesReplicationException
public static java.util.Map<TableName,java.util.List<java.lang.String>> parseTableCFsFromConfig(java.lang.String tableCFsConfig)
public void removePeer(java.lang.String id) throws ReplicationException
id
- a short name that identifies the clusterReplicationException
public void enablePeer(java.lang.String id) throws ReplicationException
id
- a short name that identifies the clusterReplicationException
public void disablePeer(java.lang.String id) throws ReplicationException
id
- a short name that identifies the clusterReplicationException
public int getPeersCount()
@Deprecated public java.util.Map<java.lang.String,java.lang.String> listPeers()
listPeerConfigs()
public java.util.Map<java.lang.String,ReplicationPeerConfig> listPeerConfigs()
public ReplicationPeerConfig getPeerConfig(java.lang.String id) throws ReplicationException
ReplicationException
public java.lang.String getPeerTableCFs(java.lang.String id) throws ReplicationException
id
- a short name that identifies the clusterReplicationException
@Deprecated public void setPeerTableCFs(java.lang.String id, java.lang.String tableCFs) throws ReplicationException
setPeerTableCFs(String, Map)
id
- a short name that identifies the clusterReplicationException
public void appendPeerTableCFs(java.lang.String id, java.lang.String tableCfs) throws ReplicationException
id
- a short that identifies the clustertableCfs
- table-cfs config strKeeperException
ReplicationException
public void appendPeerTableCFs(java.lang.String id, java.util.Map<TableName,? extends java.util.Collection<java.lang.String>> tableCfs) throws ReplicationException
id
- a short that identifies the clustertableCfs
- A map from tableName to column family namesKeeperException
ReplicationException
public void removePeerTableCFs(java.lang.String id, java.lang.String tableCf) throws ReplicationException
id
- a short name that identifies the clustertableCf
- table-cfs config strReplicationException
public void removePeerTableCFs(java.lang.String id, java.util.Map<TableName,? extends java.util.Collection<java.lang.String>> tableCfs) throws ReplicationException
id
- a short name that identifies the clustertableCfs
- A map from tableName to column family namesReplicationException
public void setPeerTableCFs(java.lang.String id, java.util.Map<TableName,? extends java.util.Collection<java.lang.String>> tableCfs) throws ReplicationException
id
- a short name that identifies the clustertableCfs
- 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
familiesReplicationException
public boolean getPeerState(java.lang.String id) throws ReplicationException
id
- String format of the Short name that identifies the peer,
an IllegalArgumentException is thrown if it doesn't existReplicationException
public void close() throws java.io.IOException
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
java.io.IOException
public java.util.List<java.util.HashMap<java.lang.String,java.lang.String>> listReplicated() throws java.io.IOException
java.io.IOException
public void enableTableRep(TableName tableName) throws java.io.IOException
tableName
- name of the tablejava.io.IOException
- if a remote or network exception occurspublic void disableTableRep(TableName tableName) throws java.io.IOException
tableName
- name of the tablejava.io.IOException
- if a remote or network exception occurs