|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.hadoop.hbase.client.HBaseAdmin
public class HBaseAdmin
Provides an interface to manage HBase database table metadata + general
administrative functions. Use HBaseAdmin to create, drop, list, enable and
disable tables. Use it also to add and drop table column families.
See HTable
to add, update, and delete data from an individual table.
Constructor Summary | |
---|---|
HBaseAdmin(org.apache.hadoop.conf.Configuration conf)
Constructor |
Method Summary | |
---|---|
void |
addColumn(byte[] tableName,
HColumnDescriptor column)
Add a column to an existing table. |
void |
addColumn(String tableName,
HColumnDescriptor column)
Add a column to an existing table. |
static void |
checkHBaseAvailable(org.apache.hadoop.conf.Configuration conf)
Check to see if HBase is running. |
void |
closeRegion(byte[] regionname,
Object... args)
Close a region. |
void |
closeRegion(String regionname,
Object... args)
Close a region. |
void |
compact(byte[] tableNameOrRegionName)
Compact a table or an individual region. |
void |
compact(String tableNameOrRegionName)
Compact a table or an individual region. |
void |
createTable(HTableDescriptor desc)
Creates a new table. |
void |
createTable(HTableDescriptor desc,
byte[][] splitKeys)
Creates a new table with an initial set of empty regions defined by the specified split keys. |
void |
createTable(HTableDescriptor desc,
byte[] startKey,
byte[] endKey,
int numRegions)
Creates a new table with the specified number of regions. |
void |
createTableAsync(HTableDescriptor desc,
byte[][] splitKeys)
Creates a new table but does not block and wait for it to come online. |
void |
deleteColumn(byte[] tableName,
byte[] columnName)
Delete a column from a table. |
void |
deleteColumn(String tableName,
String columnName)
Delete a column from a table. |
void |
deleteTable(byte[] tableName)
Deletes a table. |
void |
deleteTable(String tableName)
Deletes a table. |
void |
disableTable(byte[] tableName)
Disables a table (takes it off-line) If it is being served, the master will tell the servers to stop serving it. |
void |
disableTable(String tableName)
Disables a table (takes it off-line) If it is being served, the master will tell the servers to stop serving it. |
void |
enableTable(byte[] tableName)
Brings a table on-line (enables it). |
void |
enableTable(String tableName)
Brings a table on-line (enables it). |
void |
flush(byte[] tableNameOrRegionName)
Flush a table or an individual region. |
void |
flush(String tableNameOrRegionName)
Flush a table or an individual region. |
ClusterStatus |
getClusterStatus()
|
HConnection |
getConnection()
|
HMasterInterface |
getMaster()
|
HTableDescriptor |
getTableDescriptor(byte[] tableName)
Method for getting the tableDescriptor |
boolean |
isMasterRunning()
|
boolean |
isTableAvailable(byte[] tableName)
|
boolean |
isTableAvailable(String tableName)
|
boolean |
isTableDisabled(byte[] tableName)
|
boolean |
isTableEnabled(byte[] tableName)
|
boolean |
isTableEnabled(String tableName)
|
HTableDescriptor[] |
listTables()
List all the userspace tables. |
void |
majorCompact(byte[] tableNameOrRegionName)
Major compact a table or an individual region. |
void |
majorCompact(String tableNameOrRegionName)
Major compact a table or an individual region. |
void |
modifyColumn(byte[] tableName,
byte[] columnName,
HColumnDescriptor descriptor)
Modify an existing column family on a table. |
void |
modifyColumn(String tableName,
String columnName,
HColumnDescriptor descriptor)
Modify an existing column family on a table. |
void |
modifyTable(byte[] tableName,
HConstants.Modify op,
Object... args)
Modify an existing table. |
void |
modifyTable(byte[] tableName,
HTableDescriptor htd)
Modify an existing table, more IRB friendly version. |
void |
shutdown()
Shuts down the HBase instance |
void |
split(byte[] tableNameOrRegionName)
Split a table or an individual region. |
void |
split(String tableNameOrRegionName)
Split a table or an individual region. |
boolean |
tableExists(byte[] tableName)
|
boolean |
tableExists(String tableName)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HBaseAdmin(org.apache.hadoop.conf.Configuration conf) throws MasterNotRunningException
conf
- Configuration object
MasterNotRunningException
- if the master is not runningMethod Detail |
---|
public HConnection getConnection()
public HMasterInterface getMaster() throws MasterNotRunningException
MasterNotRunningException
- if the master is not runningpublic boolean isMasterRunning()
public boolean tableExists(String tableName) throws MasterNotRunningException
tableName
- Table to check.
MasterNotRunningException
- if the master is not runningpublic boolean tableExists(byte[] tableName) throws MasterNotRunningException
tableName
- Table to check.
MasterNotRunningException
- if the master is not runningpublic HTableDescriptor[] listTables() throws IOException
IOException
- if a remote or network exception occurspublic HTableDescriptor getTableDescriptor(byte[] tableName) throws IOException
tableName
- as a byte []
IOException
- if a remote or network exception occurspublic void createTable(HTableDescriptor desc) throws IOException
desc
- table descriptor for table
IllegalArgumentException
- if the table name is reserved
MasterNotRunningException
- if master is not running
TableExistsException
- if table already exists (If concurrent
threads, the table may have been created between test-for-existence
and attempt-at-creation).
IOException
- if a remote or network exception occurspublic void createTable(HTableDescriptor desc, byte[] startKey, byte[] endKey, int numRegions) throws IOException
desc
- table descriptor for tablestartKey
- beginning of key rangeendKey
- end of key rangenumRegions
- the total number of regions to create
IllegalArgumentException
- if the table name is reserved
MasterNotRunningException
- if master is not running
TableExistsException
- if table already exists (If concurrent
threads, the table may have been created between test-for-existence
and attempt-at-creation).
IOException
public void createTable(HTableDescriptor desc, byte[][] splitKeys) throws IOException
desc
- table descriptor for tablesplitKeys
- array of split keys for the initial regions of the table
IllegalArgumentException
- if the table name is reserved
MasterNotRunningException
- if master is not running
TableExistsException
- if table already exists (If concurrent
threads, the table may have been created between test-for-existence
and attempt-at-creation).
IOException
public void createTableAsync(HTableDescriptor desc, byte[][] splitKeys) throws IOException
desc
- table descriptor for table
IllegalArgumentException
- Bad table name.
MasterNotRunningException
- if master is not running
TableExistsException
- if table already exists (If concurrent
threads, the table may have been created between test-for-existence
and attempt-at-creation).
IOException
public void deleteTable(String tableName) throws IOException
tableName
- name of table to delete
IOException
- if a remote or network exception occurspublic void deleteTable(byte[] tableName) throws IOException
tableName
- name of table to delete
IOException
- if a remote or network exception occurspublic void enableTable(String tableName) throws IOException
tableName
- name of the table
IOException
- if a remote or network exception occurspublic void enableTable(byte[] tableName) throws IOException
tableName
- name of the table
IOException
- if a remote or network exception occurspublic void disableTable(String tableName) throws IOException
tableName
- name of table
IOException
- if a remote or network exception occurspublic void disableTable(byte[] tableName) throws IOException
tableName
- name of table
IOException
- if a remote or network exception occurspublic boolean isTableEnabled(String tableName) throws IOException
tableName
- name of table to check
IOException
- if a remote or network exception occurspublic boolean isTableEnabled(byte[] tableName) throws IOException
tableName
- name of table to check
IOException
- if a remote or network exception occurspublic boolean isTableDisabled(byte[] tableName) throws IOException
tableName
- name of table to check
IOException
- if a remote or network exception occurspublic boolean isTableAvailable(byte[] tableName) throws IOException
tableName
- name of table to check
IOException
- if a remote or network exception occurspublic boolean isTableAvailable(String tableName) throws IOException
tableName
- name of table to check
IOException
- if a remote or network exception occurspublic void addColumn(String tableName, HColumnDescriptor column) throws IOException
tableName
- name of the table to add column tocolumn
- column descriptor of column to be added
IOException
- if a remote or network exception occurspublic void addColumn(byte[] tableName, HColumnDescriptor column) throws IOException
tableName
- name of the table to add column tocolumn
- column descriptor of column to be added
IOException
- if a remote or network exception occurspublic void deleteColumn(String tableName, String columnName) throws IOException
tableName
- name of tablecolumnName
- name of column to be deleted
IOException
- if a remote or network exception occurspublic void deleteColumn(byte[] tableName, byte[] columnName) throws IOException
tableName
- name of tablecolumnName
- name of column to be deleted
IOException
- if a remote or network exception occurspublic void modifyColumn(String tableName, String columnName, HColumnDescriptor descriptor) throws IOException
tableName
- name of tablecolumnName
- name of column to be modifieddescriptor
- new column descriptor to use
IOException
- if a remote or network exception occurspublic void modifyColumn(byte[] tableName, byte[] columnName, HColumnDescriptor descriptor) throws IOException
tableName
- name of tablecolumnName
- name of column to be modifieddescriptor
- new column descriptor to use
IOException
- if a remote or network exception occurspublic void closeRegion(String regionname, Object... args) throws IOException
regionname
- region name to closeargs
- Optional server name. Otherwise, we'll send close to the
server registered in .META.
IOException
- if a remote or network exception occurspublic void closeRegion(byte[] regionname, Object... args) throws IOException
regionname
- region name to closeargs
- Optional server name. Otherwise, we'll send close to the
server registered in .META.
IOException
- if a remote or network exception occurspublic void flush(String tableNameOrRegionName) throws IOException
tableNameOrRegionName
- table or region to flush
IOException
- if a remote or network exception occurspublic void flush(byte[] tableNameOrRegionName) throws IOException
tableNameOrRegionName
- table or region to flush
IOException
- if a remote or network exception occurspublic void compact(String tableNameOrRegionName) throws IOException
tableNameOrRegionName
- table or region to compact
IOException
- if a remote or network exception occurspublic void compact(byte[] tableNameOrRegionName) throws IOException
tableNameOrRegionName
- table or region to compact
IOException
- if a remote or network exception occurspublic void majorCompact(String tableNameOrRegionName) throws IOException
tableNameOrRegionName
- table or region to major compact
IOException
- if a remote or network exception occurspublic void majorCompact(byte[] tableNameOrRegionName) throws IOException
tableNameOrRegionName
- table or region to major compact
IOException
- if a remote or network exception occurspublic void split(String tableNameOrRegionName) throws IOException
tableNameOrRegionName
- table or region to split
IOException
- if a remote or network exception occurspublic void split(byte[] tableNameOrRegionName) throws IOException
tableNameOrRegionName
- table to region to split
IOException
- if a remote or network exception occurspublic void modifyTable(byte[] tableName, HTableDescriptor htd) throws IOException
tableName
- name of table.htd
- modified description of the table
IOException
- if a remote or network exception occurspublic void modifyTable(byte[] tableName, HConstants.Modify op, Object... args) throws IOException
tableName
- name of table. May be null if we are operating on a
region.op
- table modification operationargs
- operation specific arguments
IOException
- if a remote or network exception occurspublic void shutdown() throws IOException
IOException
- if a remote or network exception occurspublic ClusterStatus getClusterStatus() throws IOException
IOException
- if a remote or network exception occurspublic static void checkHBaseAvailable(org.apache.hadoop.conf.Configuration conf) throws MasterNotRunningException
conf
- system configuration
MasterNotRunningException
- if a remote or network exception occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |