Admin Method Support

This table indicates which methods MapR-DB supports in the HBase interface Admin.

The following methods are supported with HBase tables, except where noted.

Method Name Modifier and Type Description Supported for HBase 1.1?
abort(String why, Throwable e) void Abort the server or client . No
addColumn(TableName tableName, HColumnDescriptor column) void Add a column to an existing table. Yes
assign(byte[] regionName) void Assign a region. No
balancer() boolean Invoke the balancer.
Note: MapR-DB does not require balancing. Therefore, the method is ignored.
No
cloneSnapshot(byte[] snapshotName, TableName tableName) void Create a new table by cloning the snapshot content. No
cloneSnapshot(String snapshotName, TableName tableName) void No
close() void Release any resources held. Yes
closeRegion(byte[] regionname, String serverName) void Close a region. No
closeRegion(ServerName sn, HRegionInfo hri) void No
closeRegion(String regionname, String serverName) void No
closeRegionWithEncodedRegionName(String encodedRegionName, String serverName) boolean For expert-admins. No
compact(TableName tableName, byte[] columnFamily) void Compact a column family within a table. No
compact(TableName tableName) void Compact a table. No
compactRegion(byte[] regionName, byte[] columnFamily) void Compact a column family within a region. No
compactRegion(byte[] regionName) void Compact an individual region. No
compactRegionServer(ServerName sn, boolean major) void Compact all regions on the region server No
coprocessorService() CoprocessorRpcChannel Creates and returns a RpcChannel instance connected to the active master. No
coprocessorService(ServerName sn) CoprocessorRpcChannel No
createNamespace(NamespaceDescriptor descriptor) void Create a new namespace No
createTable(HTableDescriptor desc, byte[] startKey, byte[] endKey, int numRegions) void Creates a new table with the specified number of regions. Yes
createTable(HTableDescriptor desc, byte[][] splitKeys) void Creates a new table with an initial set of empty regions defined by the specified split keys. Yes
createTable(HTableDescriptor desc) void Creates a new table. Yes
createTableAsync(HTableDescriptor desc, byte[][] splitKeys) void Creates a new table but does not block and wait for it to come online.
Note: MapR-DB treats this method as synchronous and returns null when the table is created.
Yes
deleteColumn(String tableName, String columnName) void Delete a column from a table. Yes
deleteColumn(TableName tableName, byte[] columnName) void Yes
deleteNamespace(String name) void Delete an existing namespace. No
deleteSnapshot(byte[] snapshotName) void Delete an existing snapshot. No
deleteSnapshot(String snapshotName) void No
deleteSnapshots(Pattern pattern) void Delete existing snapshots whose names match the pattern passed. No
deleteSnapshots(String regex) void No
deleteTable(String tableName) void Deletes a table Yes
deleteTable(byte[] tableName) Yes
deleteTable(TableName tableName) Yes
deleteTables(Pattern pattern) HTableDescriptor[] Delete tables matching the passed in pattern and wait on completion. Yes
deleteTables(String regex) HTableDescriptor[] Yes
disableTable (String tableName) void Disable table and wait for completion.
Note: MapR-DB does not require disabling of tables. Therefore, although it supports these methods, it only flags the table as disabled and does not perform any other operation.
Yes
disableTable(TableName tableName) void Yes
disableTableAsync (String tableName) void Disable the table but does not block and wait for it be completely disabled. Yes
disableTableAsync(TableName tableName) void Yes
disableTables(Pattern pattern) HTableDescriptor[] Disable tables matching the passed in pattern and wait on completion. Yes
disableTables(String regex) HTableDescriptor[] Yes
enableCatalogJanitor(boolean enable) boolean Enable/Disable the catalog janitor. No
enableTable(String tableName) void Enable a table.
Note: MapR-DB does not require enabling of tables. Therefore, although it supports this method, it only flags the table as enabled and does not perform any other operation.
Yes
enableTable(bye[] tableName) void Yes
enableTable(TableName tableName) void Yes
enableTableAsync (String tableName) void Yes
enableTableAsync(TableName tableName) void Enable the table but does not block and wait for it be completely enabled. Yes
enableTables(Pattern pattern) HTableDescriptor[] Enable tables matching the passed in pattern and wait on completion. Yes
enableTables(String regex) Yes
execProcedure(String signature, String instance, Map<String,String> props) void Execute a distributed procedure on a cluster. No
execProcedureWithRet(String signature, String instance, Map<String,String> props) byte[] No
flush(TableName tableName) void Flush a table. Yes
flush(byte[] tableNameOrRegionName) void Yes
flush(String tableNameOrRegionName) void Yes
flushRegion(byte[] regionName) void Flush an individual region. Yes
getAlterStatus(byte[] tableName) Pair<Integer,Integer> Get the status of alter command - indicates how many regions have received the updated schema Asynchronous operation.
Note: MapR-DB always returns (0,0).
No
getAlterStatus(TableName tableName) Pair<Integer,Integer> No
getClusterStatus() ClusterStatus Get the status of the cluster. No
getCompactionState(String tableNameOrRegionName) CompactionState Get the current compaction state of a table. No
getCompactionState(TableName tableName) org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState No
getCompactionStateForRegion(byte[] regionName) org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState Get the current compaction state of region. No
getConfiguration() org.apache.hadoop.conf.Configuration Get the configuration used by the instance. Yes
getConnection() Connection Get the connection used by this object. Yes
getMasterCoprocessors() String[] Helper delegage to getClusterStatus().getMasterCoprocessors(). No
getMasterInfoPort() int Get the info port of the current master if one is available. No
getNamespaceDescriptor(String name) NamespaceDescriptor Get a namespace descriptor by name. No
getOnlineRegions(ServerName sn) List<HRegionInfo> Get all the online regions on a region server. No
getOperationTimeout() int MapR-DB never uses the timeout value.
Note: If v1.1 API is used with MapR-DB, the method is ignored. MapR-DB does not use the timeout value.
No
getQuotaRetriever(QuotaFilter filter) QuotaRetriever Return a QuotaRetriever to list the quotas based on the filter. No
getTableDescriptor (byte[] tableName) HTableDescriptor Yes
getTableDescriptor(TableName tableName) HTableDescriptor Method for getting the tableDescriptor. Yes
getTableDescriptors(List<String> names) HTableDescriptor[] Get tableDescriptors. Yes
getTableDescriptorsByTableName(List<TableName> tableNames) HTableDescriptor[] Yes
getTableRegions (byte[] tableName) List<HRegionInfo> Get the regions of a given table. Yes
getTableRegions(TableName tableName) List<HRegionInfo> Yes
isAborted() boolean Check if the server or client was aborted. No
isCatalogJanitorEnabled() boolean Query on the catalog janitor state. MapR-DB always returns false. No
isProcedureFinished(String signature, String instance, Map<String,String> props) boolean Check the current state of the specified procedure. No
isSnapshotFinished(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot) boolean Check the current state of the passed snapshot. No
isTableAvailable(String tableName) boolean Check if all regions of the table are available. Yes
isTableAvailable(TableName tableName, byte[][] splitKeys) boolean Use this API to check if the table has been created with the specified number of splitkeys which was used while creating the given table. No
isTableAvailable(TableName tableName) boolean Returns true if all regions of the table are available. Yes
isTableDisabled(String tableName) boolean Check if table is offline.
Note: Although MapR-DB supports this method, it only checks the flag.
Yes
isTableDisabled(TableName tableName) boolean Yes
isTableEnabled(String tableName) boolean Check if table is online.
Note: Although MapR-DB supports this method, it only checks the flag and does not change the flag.
Yes
isTableEnabled(TableName tableName) boolean Yes
listNamespaceDescriptors() NamespaceDescriptor[] List available namespace descriptors No
listSnapshots() List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> List completed snapshots. No
listSnapshots(Pattern pattern) List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> List all the completed snapshots matching the given pattern. No
listSnapshots(String regex) List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> List all the completed snapshots matching the given regular expression. No
listTableDescriptorsByNamespace(String name) HTableDescriptor[] Get list of table descriptors by namespace. No
listTableNames() TableName[] List all of the names of userspace tables. Yes
listTableNames(Pattern pattern, boolean includeSysTables) TableName[] Yes
listTableNames(Pattern pattern) TableName[] Yes
listTableNames(String regex, boolean includeSysTables) TableName[] Yes
listTableNames(String regex) TableName[] Yes
listTableNamesByNamespace(String name) TableName[] Get list of table names by namespace. No
listTables() HTableDescriptor[] List all the userspace tables. Yes
listTables(Pattern pattern, boolean includeSysTables) HTableDescriptor[] List all the tables matching the given pattern.
Note: MapR-DB does not have system tables and so, the boolean value is ignored.
Yes
listTables(Pattern pattern) HTableDescriptor[] List all the userspace tables matching the given pattern. Yes
listTables(String regex, boolean includeSysTables) HTableDescriptor[] List all the tables matching the given pattern.
Note: MapR-DB does not have system tables and so, the boolean value is ignored.
Yes
listTables(String regex) HTableDescriptor[] List all the userspace tables matching the given regular expression. Yes
majorCompact(byte[] tableNameOrRegionName) void Compact a table or an individual region. Deprecated
majorCompact(String tableNameOrRegionName) void Deprecated
majorCompact(byte[] tableNameOrRegionName, byte[] columnFamily) void Compact a column family within a table or region. Deprecated
majorCompact(String tableNameOrRegionName, String columnFamily) void Deprecated
majorCompactRegion(byte[] regionName, byte[] columnFamily) void Major compact a column family within region. No
majorCompactRegion(byte[] regionName) void Major compact a table or an individual region. No
mergeRegions(byte[] nameOfRegionA, byte[] nameOfRegionB, boolean forcible) void Merge two regions. No
modifyColumn(String tableName, HColumnDescriptor descriptor) void Modify an existing column family on a table. Yes
modifyColumn(TableName tableName, HColumnDescriptor columnFamily) void Yes
modifyNamespace(NamespaceDescriptor descriptor) void Modify an existing namespace. No
modifyTable (byte[] tableName, HTableDescriptor htd) void Modify an existing table. Yes
modifyTable(final String tableName, final HTableDescriptor htd) void Yes
modifyTable(TableName tableName, HTableDescriptor htd) void Modify an existing table, more IRB friendly version. Yes
move(byte[] encodedRegionName, byte[] destServerName) void Move the region r to dest. No
offline(byte[] regionName) void Offline specified region from master's in-memory state. No
restoreSnapshot(byte[] snapshotName, boolean takeFailSafeSnapshot) void Restore the specified snapshot on the original table. No
restoreSnapshot(byte[] snapshotName) void No
restoreSnapshot(String snapshotName, boolean takeFailSafeSnapshot) void No
restoreSnapshot(String snapshotName) void No
rollWALWriter(ServerName serverName) void Roll the log writer. No
runCatalogScan() int Ask for a scan of the catalog table. No
setBalancerRunning(boolean on, boolean synchronous) boolean Turn the load balancer on or off.
Note: MapR-DB does not require balancing. Therefore, the method just sets a flag and there is no impact on the MapR table.
No
setQuota(QuotaSettings quota) void Apply the new quota settings. No
shutdown() void Shuts down the HBase cluster. No
snapshot(byte[] snapshotName, TableName tableName) void Create a timestamp consistent snapshot for the given table. No
snapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot) void Take a snapshot and wait for the server to complete that snapshot (blocking). No
snapshot(String snapshotName, TableName tableName, org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription.Type type) void Create typed snapshot of the table. No
snapshot(String snapshotName, TableName tableName) void Take a snapshot for the given table. No
split(byte[] tableNameOrRegionName) void Split a table.
Note: The tableNameOrRegionName parameter has a different format when used with MapR tables than with Apache HBase tables. With MapR Tables, specify both the table path and the FID as a comma-separated list.
Yes
split(TableName tableName, byte[] splitPoint) void No
split(TableName tableName) void Yes
splitRegion(byte[] regionName, byte[] splitPoint) void Split an individual region. No
splitRegion(byte[] regionName) void Yes
stopMaster() void Shuts down the current HBase master only. No
stopRegionServer(String hostnamePort) void Stop the designated regionserver. No
tableExists(TableName tableName) boolean Return whether a table with given name exists. Yes
tableExists(byte[] tableName) boolean Yes
tableExists(String tableName) boolean Yes
takeSnapshotAsync(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot) org.apache.hadoop.hbase.protobuf.generated.MasterProtos.SnapshotResponse Take a snapshot without waiting for the server to complete that snapshot (asynchronous) Only a single snapshot should be taken at a time, or results may be undefined. No
truncateTable(TableName tableName, boolean preserveSplits) void Truncate a table. Yes
unassign(byte[] regionName, boolean force) void Unassign a region from current hosting regionserver. No
updateConfiguration() void Update the configuration and trigger an online config change on all the regionservers. No
updateConfiguration(ServerName server) void No