org.apache.hadoop.hbase.client

接口 AliHBaseAdminInterface

所有超级接口:

org.apache.hadoop.hbase.Abortable, org.apache.hadoop.hbase.client.Admin, AutoCloseable, Closeable

所有已知实现类:

AliHBaseMultiAdmin, AliHBaseUEAdmin

public interface AliHBaseAdminInterface
extends org.apache.hadoop.hbase.client.Admin

Provide some new feature interfaces

方法概要

限定符和类型	方法和说明
void	createIndex(AliHBaseIndexDescriptor indexDescriptor) Create a global secondary index table against a specified data table, block forever until operation success.
void	createIndex(AliHBaseIndexDescriptor indexDescriptor, byte[][] splitKeys) Create a global secondary index table against a specified data table with split keys, block forever until operation success.
void	createIndex(AliHBaseIndexDescriptor indexDescriptor, byte[] startKey, byte[] endKey, int numRegions) Create a global secondary index table against a specified data table, block forever until operation success.
void	deleteIndex(String indexName, org.apache.hadoop.hbase.TableName dataTable) Drop index and clean all index data synchronously, block forever until operation done.
List<AliHBaseIndexDescriptor>	describeIndex(org.apache.hadoop.hbase.TableName dataTableName) Get index schema for specified data table.
void	offlineIndex(String indexName, org.apache.hadoop.hbase.TableName dataTable) Modify index status to DISABLED, block forever until operation done.

从接口继承的方法 org.apache.hadoop.hbase.client.Admin

abort, abortProcedure, abortProcedureAsync, addColumn, addColumnFamily, addColumnFamilyAsync, addReplicationPeer, addReplicationPeer, appendReplicationPeerTableCFs, assign, balance, balance, balancer, balancer, balancerSwitch, catalogJanitorSwitch, cleanerChoreSwitch, clearBlockCache, clearCompactionQueues, clearDeadServers, cloneSnapshot, cloneSnapshot, cloneSnapshot, cloneSnapshotAsync, close, closeRegion, closeRegion, closeRegion, closeRegionWithEncodedRegionName, compact, compact, compact, compact, compactRegion, compactRegion, compactRegionServer, compactRegionServer, coprocessorService, coprocessorService, createNamespace, createNamespaceAsync, createTable, createTable, createTable, createTableAsync, decommissionRegionServers, deleteColumn, deleteColumnFamily, deleteColumnFamilyAsync, deleteNamespace, deleteNamespaceAsync, deleteSnapshot, deleteSnapshot, deleteSnapshots, deleteSnapshots, deleteTable, deleteTableAsync, deleteTables, deleteTables, deleteTableSnapshots, deleteTableSnapshots, disableReplicationPeer, disableTable, disableTableAsync, disableTableReplication, disableTables, disableTables, enableCatalogJanitor, enableReplicationPeer, enableTable, enableTableAsync, enableTableReplication, enableTables, enableTables, execProcedure, execProcedureWithRet, execProcedureWithReturn, flush, flushRegion, flushRegionServer, getAlterStatus, getAlterStatus, getBackupMasters, getClusterMetrics, getClusterMetrics, getClusterStatus, getCompactionState, getCompactionState, getCompactionStateForRegion, getConfiguration, getConnection, getDescriptor, getLastMajorCompactionTimestamp, getLastMajorCompactionTimestampForRegion, getLocks, getMaster, getMasterCoprocessorNames, getMasterCoprocessors, getMasterInfoPort, getNamespaceDescriptor, getOnlineRegions, getOperationTimeout, getProcedures, getQuota, getQuotaRetriever, getRegionMetrics, getRegionMetrics, getRegions, getRegions, getRegionServers, getReplicationPeerConfig, getSecurityCapabilities, getTableDescriptor, getTableDescriptors, getTableDescriptorsByTableName, getTableRegions, isAborted, isBalancerEnabled, isCatalogJanitorEnabled, isCleanerChoreEnabled, isMasterInMaintenanceMode, isMergeEnabled, isNormalizerEnabled, isProcedureFinished, isSnapshotFinished, isSplitEnabled, isSplitOrMergeEnabled, isTableAvailable, isTableAvailable, isTableDisabled, isTableEnabled, listDeadServers, listDecommissionedRegionServers, listNamespaceDescriptors, listReplicatedTableCFs, listReplicationPeers, listReplicationPeers, listSnapshots, listSnapshots, listSnapshots, listTableDescriptors, listTableDescriptors, listTableDescriptors, listTableDescriptors, listTableDescriptorsByNamespace, listTableDescriptorsByNamespace, listTableNames, listTableNames, listTableNames, listTableNames, listTableNames, listTableNamesByNamespace, listTables, listTables, listTables, listTables, listTables, listTableSnapshots, listTableSnapshots, majorCompact, majorCompact, majorCompact, majorCompact, majorCompactRegion, majorCompactRegion, majorCompactRegionServer, mergeRegions, mergeRegionsAsync, mergeRegionsAsync, mergeSwitch, modifyColumn, modifyColumnFamily, modifyColumnFamilyAsync, modifyNamespace, modifyNamespaceAsync, modifyTable, modifyTable, modifyTableAsync, modifyTableAsync, move, normalize, normalizerSwitch, offline, recommissionRegionServer, removeReplicationPeer, removeReplicationPeerTableCFs, restoreSnapshot, restoreSnapshot, restoreSnapshot, restoreSnapshot, restoreSnapshot, restoreSnapshotAsync, rollWALWriter, runCatalogJanitor, runCatalogScan, runCleanerChore, setBalancerRunning, setCleanerChoreRunning, setNormalizerRunning, setQuota, setSplitOrMergeEnabled, shutdown, snapshot, snapshot, snapshot, snapshot, snapshotAsync, split, split, splitRegion, splitRegion, splitRegionAsync, splitSwitch, stopMaster, stopRegionServer, tableExists, takeSnapshotAsync, truncateTable, truncateTableAsync, unassign, updateConfiguration, updateConfiguration, updateReplicationPeerConfig

方法详细资料

describeIndex

List<AliHBaseIndexDescriptor> describeIndex(org.apache.hadoop.hbase.TableName dataTableName)
                                     throws IOException

Get index schema for specified data table. Return empty list if no index found, never return null.

参数:

dataTableName - data table name

返回:

all index descriptors of the specified data table; if no index found for this data table, then return an empty list.

抛出:

IOException

createIndex

void createIndex(AliHBaseIndexDescriptor indexDescriptor)
          throws IOException

Create a global secondary index table against a specified data table, block forever until operation success. This call needs to wait for the index data to be built, may consume relatively long time, and thus may block current thread.

参数:

indexDescriptor - descriptor of index table

抛出:

IOException

createIndex

void createIndex(AliHBaseIndexDescriptor indexDescriptor,
                 byte[][] splitKeys)
          throws IOException

Create a global secondary index table against a specified data table with split keys, block forever until operation success. This call needs to wait for the index data to be built, may consume relatively long time, and thus may block current thread.

参数:

indexDescriptor - descriptor of index table

splitKeys - pre-split range of index table

抛出:

IOException

createIndex

void createIndex(AliHBaseIndexDescriptor indexDescriptor,
                 byte[] startKey,
                 byte[] endKey,
                 int numRegions)
          throws IOException

Create a global secondary index table against a specified data table, block forever until operation success. Index table will be split into numRegions initial regions, with startKey, endKey specified. This call needs to wait for the index data to be built, may consume relatively long time, and thus may block current thread.

参数:

indexDescriptor - descriptor of index table

startKey - start range key of index table

endKey - end range key of index table

numRegions - number of initial regions

抛出:

IOException

deleteIndex

void deleteIndex(String indexName,
                 org.apache.hadoop.hbase.TableName dataTable)
          throws IOException

Drop index and clean all index data synchronously, block forever until operation done. The #offlineIndex(String, TableName) operation must be performed first.

参数:

indexName - index name

dataTable - name of main table

抛出:

IOException

offlineIndex

void offlineIndex(String indexName,
                  org.apache.hadoop.hbase.TableName dataTable)
           throws IOException

Modify index status to DISABLED, block forever until operation done. Re-online is not supported, index must be deleted and re-created.

参数:

indexName - index name

dataTable - name of main table

抛出:

IOException