Supported and Unsupported Methods in Admin
(HBase 0.98 and higher)
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? | |
---|---|---|---|---|
HBase 0.98 | HBase 1.1 | |||
abort(String why, Throwable e) |
void | Abort the server or client . | No | No |
addColumn(TableName tableName, HColumnDescriptor
column) |
void | Add a column to an existing table. | Yes | Yes |
assign(byte[] regionName) |
void | Assign a region. | No | No |
balancer() |
boolean | Invoke the balancer. NOTE: MapR-DB does not require balancing. Therefore, the
method is ignored. |
No | No |
cloneSnapshot(byte[] snapshotName, TableName
tableName) |
void | Create a new table by cloning the snapshot content. | No | No |
cloneSnapshot(String snapshotName, TableName
tableName) |
void | No | No | |
close() |
void | Release any resources held. | Yes | Yes |
closeRegion(byte[] regionname, String serverName) |
void | Close a region. | No | No |
closeRegion(ServerName sn, HRegionInfo hri) |
void | No | No | |
closeRegion(String regionname, String serverName) |
void | No | No | |
closeRegionWithEncodedRegionName(String encodedRegionName, String
serverName) |
boolean | For expert-admins. | No | No |
compact(TableName tableName, byte[] columnFamily) |
void | Compact a column family within a table. | No | No |
compact(TableName tableName) |
void | Compact a table. | No | No |
compactRegion(byte[] regionName, byte[] columnFamily) |
void | Compact a column family within a region. | No | No |
compactRegion(byte[] regionName) |
void | Compact an individual region. | No | No |
compactRegionServer(ServerName sn, boolean major) |
void | Compact all regions on the region server | No | No |
coprocessorService() |
CoprocessorRpcChannel | Creates and returns a RpcChannel instance connected to the active master. | No | No |
coprocessorService(ServerName sn) |
CoprocessorRpcChannel | No | No | |
createNamespace(NamespaceDescriptor descriptor) |
void | Create a new namespace | No | No |
createTable(HTableDescriptor desc, byte[] startKey, byte[] endKey, int
numRegions) |
void | Creates a new table with the specified number of regions. | Yes | 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 | Yes |
createTable(HTableDescriptor desc) |
void | Creates a new table. | Yes | 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 | Yes |
deleteColumn(String tableName, String columnName) |
void | Delete a column from a table. | Yes | Yes |
deleteColumn(TableName tableName, byte[] columnName) |
void | Yes | Yes | |
deleteNamespace(String name) |
void | Delete an existing namespace. | No | No |
deleteSnapshot(byte[] snapshotName) |
void | Delete an existing snapshot. | No | No |
deleteSnapshot(String snapshotName) |
void | No | No | |
deleteSnapshots(Pattern pattern) |
void | Delete existing snapshots whose names match the pattern passed. | No | No |
deleteSnapshots(String regex) |
void | No | No | |
deleteTable(String tableName) |
void | Deletes a table | Yes | Yes |
deleteTable(byte[] tableName) |
Yes | Yes | ||
deleteTable(TableName tableName) |
Yes | Yes | ||
deleteTables(Pattern pattern) |
HTableDescriptor[] | Delete tables matching the passed in pattern and wait on completion. | Yes | Yes |
deleteTables(String regex) |
HTableDescriptor[] | Yes | 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 | Yes |
disableTable(TableName tableName) |
void | Yes | Yes | |
disableTableAsync (String tableName) |
void | Disable the table but does not block and wait for it be completely disabled. | Yes | Yes |
disableTableAsync(TableName tableName) |
void | Yes | Yes | |
disableTables(Pattern pattern) |
HTableDescriptor[] | Disable tables matching the passed in pattern and wait on completion. | Yes | Yes |
disableTables(String regex) |
HTableDescriptor[] | Yes | Yes | |
enableCatalogJanitor(boolean enable) |
boolean | Enable/Disable the catalog janitor. | No | 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 | Yes |
enableTable(bye[] tableName) |
void | Yes | Yes | |
enableTable(TableName tableName) |
void | Yes | Yes | |
enableTableAsync (String tableName) |
void | Yes | Yes | |
enableTableAsync(TableName tableName) |
void | Enable the table but does not block and wait for it be completely enabled. | Yes | Yes |
enableTables(Pattern pattern) |
HTableDescriptor[] | Enable tables matching the passed in pattern and wait on completion. | Yes | Yes |
enableTables(String regex) |
Yes | Yes | ||
execProcedure(String signature, String instance,
Map<String,String> props) |
void | Execute a distributed procedure on a cluster. | No | No |
execProcedureWithRet(String signature, String instance,
Map<String,String> props) |
byte[] | No | No | |
flush(TableName tableName) |
void | Flush a table. | No | Yes |
flush(byte[] tableNameOrRegionName) |
void | Yes | Yes | |
flush(String tableNameOrRegionName) |
void | Yes | Yes | |
flushRegion(byte[] regionName) |
void | Flush an individual region. | No | 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 | No |
getAlterStatus(TableName tableName) |
Pair<Integer,Integer> | No | No | |
getClusterStatus() |
ClusterStatus | Get the status of the cluster. | No | No |
getCompactionState(String tableNameOrRegionName) |
CompactionState | Get the current compaction state of a table. | No | No |
getCompactionState(TableName tableName) |
org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState | No | No | |
getCompactionStateForRegion(byte[] regionName) |
org.apache.hadoop.hbase.protobuf.generated.AdminProtos.GetRegionInfoResponse.CompactionState | Get the current compaction state of region. | No | No |
getConfiguration() |
org.apache.hadoop.conf.Configuration | Get the configuration used by the instance. | Yes | Yes |
getConnection() |
Connection | Get the connection used by this object. | No | Yes |
getMasterCoprocessors() |
String[] | Helper delegage to getClusterStatus().getMasterCoprocessors(). | No | No |
getMasterInfoPort() |
int | Get the info port of the current master if one is available. | No | No |
getNamespaceDescriptor(String name) |
NamespaceDescriptor | Get a namespace descriptor by name. | No | No |
getOnlineRegions(ServerName sn) |
List<HRegionInfo> | Get all the online regions on a region server. | No | No |
getOperationTimeout()
i |
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 | No |
getQuotaRetriever(QuotaFilter filter) |
QuotaRetriever | Return a QuotaRetriever to list the quotas based on the filter. | No | No |
getTableDescriptor (byte[] tableName) |
HTableDescriptor | Yes | Yes | |
getTableDescriptor(TableName tableName) |
HTableDescriptor | Method for getting the tableDescriptor. | Yes | Yes |
getTableDescriptors(List<String> names) |
HTableDescriptor[] | Get tableDescriptors. | Yes | Yes |
getTableDescriptorsByTableName(List<TableName>
tableNames) |
HTableDescriptor[] | Yes | Yes | |
getTableRegions (byte[] tableName) |
List<HRegionInfo> | Get the regions of a given table. | Yes | Yes |
getTableRegions(TableName tableName) |
List<HRegionInfo> | Yes | Yes | |
isAborted() |
boolean | Check if the server or client was aborted. | No | No |
isCatalogJanitorEnabled() |
boolean | Query on the catalog janitor state. MapR-DB always returns false. | No | No |
isProcedureFinished(String signature, String instance,
Map<String,String> props) |
boolean | Check the current state of the specified procedure. | No | No |
isSnapshotFinished(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription
snapshot) |
boolean | Check the current state of the passed snapshot. | No | No |
isTableAvailable(String tableName) |
boolean | Check if all regions of the table are available. | Yes | 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 | No |
isTableAvailable(TableName tableName) |
boolean | Returns true if all regions of the table are available. | Yes | Yes |
isTableDisabled(String tableName) |
boolean | Check if table is offline. NOTE: Although MapR-DB supports this
method, it only checks the flag. |
Yes | Yes |
isTableDisabled(TableName tableName) |
boolean | Yes | 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 | Yes |
isTableEnabled(TableName tableName) |
boolean | Yes | Yes | |
listNamespaceDescriptors() |
NamespaceDescriptor[] | List available namespace descriptors | No | No |
listSnapshots() |
List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> | List completed snapshots. | No | No |
listSnapshots(Pattern pattern) |
List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> | List all the completed snapshots matching the given pattern. | No | No |
listSnapshots(String regex) |
List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> | List all the completed snapshots matching the given regular expression. | No | No |
listTableDescriptorsByNamespace(String name) |
HTableDescriptor[] | Get list of table descriptors by namespace. | No | No |
listTableNames() |
TableName[] | List all of the names of userspace tables. | Yes | Yes |
listTableNames(Pattern pattern, boolean
includeSysTables) |
TableName[] | No | Yes | |
listTableNames(Pattern pattern) |
TableName[] | No | Yes | |
listTableNames(String regex, boolean includeSysTables) |
TableName[] | No | Yes | |
listTableNames(String regex) |
TableName[] | No | Yes | |
listTableNamesByNamespace(String name) |
TableName[] | Get list of table names by namespace. | No | No |
listTables() |
HTableDescriptor[] | List all the userspace tables. | Yes | 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. |
No | Yes |
listTables(Pattern pattern) |
HTableDescriptor[] | List all the userspace tables matching the given pattern. | Yes | 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. |
No | Yes |
listTables(String regex) |
HTableDescriptor[] | List all the userspace tables matching the given regular expression. | Yes | Yes |
majorCompact(byte[] tableNameOrRegionName) |
void | Compact a table or an individual region. | No | Deprecated |
majorCompact(String tableNameOrRegionName)
|
void | No | Deprecated | |
majorCompact(byte[] tableNameOrRegionName, byte[]
columnFamily) |
void | Compact a column family within a table or region. | No | Deprecated |
majorCompact(String tableNameOrRegionName, String
columnFamily) |
void | No | Deprecated | |
majorCompactRegion(byte[] regionName, byte[]
columnFamily) |
void | Major compact a column family within region. | No | No |
majorCompactRegion(byte[] regionName) |
void | Major compact a table or an individual region. | No | No |
mergeRegions(byte[] nameOfRegionA, byte[] nameOfRegionB, boolean
forcible) |
void | Merge two regions. | No | No |
modifyColumn(String tableName, HColumnDescriptor
descriptor) |
void | Modify an existing column family on a table. | Yes | Yes |
modifyColumn(TableName tableName, HColumnDescriptor
columnFamily) |
void | Yes | Yes | |
modifyNamespace(NamespaceDescriptor descriptor) |
void | Modify an existing namespace. | No | No |
modifyTable (byte[] tableName, HTableDescriptor htd) |
void | Modify an existing table. | Yes | Yes |
modifyTable(final String tableName, final HTableDescriptor
htd)
|
void | Yes | Yes | |
modifyTable(TableName tableName, HTableDescriptor htd) |
void | Modify an existing table, more IRB friendly version. | Yes | Yes |
move(byte[] encodedRegionName, byte[] destServerName) |
void | Move the region r to dest. | No | No |
offline(byte[] regionName) |
void | Offline specified region from master's in-memory state. | No | No |
restoreSnapshot(byte[] snapshotName, boolean
takeFailSafeSnapshot) |
void | Restore the specified snapshot on the original table. | No | No |
restoreSnapshot(byte[] snapshotName) |
void | No | No | |
restoreSnapshot(String snapshotName, boolean
takeFailSafeSnapshot) |
void | No | No | |
restoreSnapshot(String snapshotName) |
void | No | No | |
rollWALWriter(ServerName serverName) |
void | Roll the log writer. | No | No |
runCatalogScan() |
int | Ask for a scan of the catalog table. | No | 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 | No |
setQuota(QuotaSettings quota) |
void | Apply the new quota settings. | No | No |
shutdown() |
void | Shuts down the HBase cluster. | No | No |
snapshot(byte[] snapshotName, TableName tableName) |
void | Create a timestamp consistent snapshot for the given table. | No | 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 | No |
snapshot(String snapshotName, TableName tableName,
org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription.Type
type) |
void | Create typed snapshot of the table. | No | No |
snapshot(String snapshotName, TableName tableName) |
void | Take a snapshot for the given table. | No | 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 | Yes |
split(TableName tableName, byte[] splitPoint) |
void | No | No | |
split(TableName tableName) |
void | Yes | Yes | |
splitRegion(byte[] regionName, byte[] splitPoint) |
void | Split an individual region. | No | No |
splitRegion(byte[] regionName) |
void | No | Yes | |
stopMaster() |
void | Shuts down the current HBase master only. | No | No |
stopRegionServer(String hostnamePort) |
void | Stop the designated regionserver. | No | No |
tableExists(TableName tableName) |
boolean | Return whether a table with given name exists. | Yes | Yes |
tableExists(byte[] tableName) |
boolean | Yes | Yes | |
tableExists(String tableName) |
boolean | Yes | 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 | No |
truncateTable(TableName tableName, boolean
preserveSplits) |
void | Truncate a table. | Yes | Yes |
unassign(byte[] regionName, boolean force) |
void | Unassign a region from current hosting regionserver. | No | No |
updateConfiguration() |
void | Update the configuration and trigger an online config change on all the regionservers. | No | No |
updateConfiguration(ServerName server) |
void | No | No |
i In v0.98, this is Table API.