com.alipay.oceanbase.hbase

类 OHTable

java.lang.Object

com.alipay.oceanbase.hbase.OHTable

所有已实现的接口:

Closeable, AutoCloseable, org.apache.hadoop.hbase.client.HTableInterface

public class OHTable
extends Object
implements org.apache.hadoop.hbase.client.HTableInterface

构造器概要

构造器

构造器和说明
OHTable(byte[] tableName, com.alipay.oceanbase.rpc.ObTableClient obTableClient, ExecutorService executePool) Creates an object to access a HBase table.
OHTable(org.apache.hadoop.conf.Configuration configuration, byte[] tableName) Creates an object to access a HBase table.
OHTable(org.apache.hadoop.conf.Configuration configuration, byte[] tableName, ExecutorService executePool) Creates an object to access a HBase table.
OHTable(org.apache.hadoop.conf.Configuration configuration, String tableName) Creates an object to access a HBase table.

方法概要

限定符和类型	方法和说明
org.apache.hadoop.hbase.client.Result	append(org.apache.hadoop.hbase.client.Append append) 例如 key = "key", c1="a"，在c1后面append，使c1="aaa" 原子操作
Object[]	batch(List<? extends org.apache.hadoop.hbase.client.Row> actions)
void	batch(List<? extends org.apache.hadoop.hbase.client.Row> actions, Object[] results)
boolean	checkAndDelete(byte[] row, byte[] family, byte[] qualifier, byte[] value, org.apache.hadoop.hbase.client.Delete delete) 例如当 key="key001", family = "family", c1="a" 时，才执行 delete 操作，该命令是原子的
boolean	checkAndPut(byte[] row, byte[] family, byte[] qualifier, byte[] value, org.apache.hadoop.hbase.client.Put put) 例如当 key="key001", family = "family", c1="a" 时，才执行 put 操作，该命令是原子的
void	close()
<T extends org.apache.hadoop.hbase.ipc.CoprocessorProtocol,R> Map<byte[],R>	coprocessorExec(Class<T> protocol, byte[] startKey, byte[] endKey, org.apache.hadoop.hbase.client.coprocessor.Batch.Call<T,R> callable)
<T extends org.apache.hadoop.hbase.ipc.CoprocessorProtocol,R> void	coprocessorExec(Class<T> protocol, byte[] startKey, byte[] endKey, org.apache.hadoop.hbase.client.coprocessor.Batch.Call<T,R> callable, org.apache.hadoop.hbase.client.coprocessor.Batch.Callback<R> callback)
<T extends org.apache.hadoop.hbase.ipc.CoprocessorProtocol> T	coprocessorProxy(Class<T> protocol, byte[] row)
static ThreadPoolExecutor	createDefaultThreadPoolExecutor(int coreSize, int maxThreads, long keepAliveTime) 创建默认的线程池 Using the "direct handoff" approach, new threads will only be created if it is necessary and will grow unbounded.
void	delete(org.apache.hadoop.hbase.client.Delete delete)
void	delete(List<org.apache.hadoop.hbase.client.Delete> deletes)
boolean	exists(org.apache.hadoop.hbase.client.Get get) Test for the existence of columns in the table, as specified in the Get.
void	flushCommits()
org.apache.hadoop.hbase.client.Result	get(org.apache.hadoop.hbase.client.Get get)
org.apache.hadoop.hbase.client.Result[]	get(List<org.apache.hadoop.hbase.client.Get> gets)
org.apache.hadoop.conf.Configuration	getConfiguration()
byte[][]	getEndKeys()
void	getKeyValueFromResult(com.alipay.oceanbase.rpc.protocol.payload.impl.execute.query.AbstractQueryStreamResult clientQueryStreamResult, List<org.apache.hadoop.hbase.KeyValue> keyValueList, boolean isTableGroup, byte[] family)
org.apache.hadoop.hbase.client.Result	getRowOrBefore(byte[] row, byte[] family) hbase的获取这个rowkey，没有的话就前一个rowkey，不支持
org.apache.hadoop.hbase.client.ResultScanner	getScanner(byte[] family)
org.apache.hadoop.hbase.client.ResultScanner	getScanner(byte[] family, byte[] qualifier)
org.apache.hadoop.hbase.client.ResultScanner	getScanner(org.apache.hadoop.hbase.client.Scan scan)
org.apache.hadoop.hbase.util.Pair<byte[][],byte[][]>	getStartEndKeys()
byte[][]	getStartKeys()
org.apache.hadoop.hbase.HTableDescriptor	getTableDescriptor()
byte[]	getTableName()
long	getWriteBufferSize() Returns the maximum size in bytes of the write buffer for this HTable.
org.apache.hadoop.hbase.client.Result	increment(org.apache.hadoop.hbase.client.Increment increment) 例如 key = "key", c2=1，在c2后面increment，在c2后面加2，变成 c2=3 原子操作
long	incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount) 直接通过 column 名进行 increment 操作
long	incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount, boolean writeToWAL)
boolean	isAutoFlush()
org.apache.hadoop.hbase.client.RowLock	lockRow(byte[] row)
void	mutateRow(org.apache.hadoop.hbase.client.RowMutations rm)
void	put(List<org.apache.hadoop.hbase.client.Put> puts)
void	put(org.apache.hadoop.hbase.client.Put put)
void	refreshTableEntry(String familyString, boolean hasTestLoad)
void	setAutoFlush(boolean autoFlush) See setAutoFlush(boolean, boolean)
void	setAutoFlush(boolean autoFlush, boolean clearBufferOnFail) Turns 'auto-flush' on or off.
void	setOperationTimeout(int operationTimeout)
void	setRuntimeBatchExecutor(ExecutorService runtimeBatchExecutor)
void	setWriteBufferSize(long writeBufferSize) Sets the size of the buffer in bytes.
void	unlockRow(org.apache.hadoop.hbase.client.RowLock rl)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

OHTable

public OHTable(org.apache.hadoop.conf.Configuration configuration,
               String tableName)
        throws IOException

Creates an object to access a HBase table. Shares oceanbase table obTableClient and other resources with other OHTable instances created with the same configuration instance. Uses already-populated region cache if one is available, populated by any other OHTable instances sharing this configuration instance. Recommended.

参数:

configuration - Configuration object to use.

tableName - Name of the table.

抛出:

IllegalArgumentException - if the param error

IOException - if a remote or network exception occurs

OHTable

public OHTable(org.apache.hadoop.conf.Configuration configuration,
               byte[] tableName)
        throws IOException

Creates an object to access a HBase table. Shares oceanbase table obTableClient and other resources with other OHTable instances created with the same configuration instance. Uses already-populated region cache if one is available, populated by any other OHTable instances sharing this configuration instance. Recommended.

参数:

configuration - Configuration object to use.

tableName - Name of the table.

抛出:

IOException - if a remote or network exception occurs

IllegalArgumentException - if the param error

OHTable

public OHTable(org.apache.hadoop.conf.Configuration configuration,
               byte[] tableName,
               ExecutorService executePool)
        throws IOException

Creates an object to access a HBase table. Shares oceanbase table obTableClient and other resources with other OHTable instances created with the same configuration instance. Uses already-populated region cache if one is available, populated by any other OHTable instances sharing this configuration instance. Use this constructor when the ExecutorService is externally managed.

参数:

configuration - Configuration object to use.

tableName - Name of the table.

executePool - ExecutorService to be used.

抛出:

IOException - if a remote or network exception occurs

IllegalArgumentException - if the param error

OHTable

public OHTable(byte[] tableName,
               com.alipay.oceanbase.rpc.ObTableClient obTableClient,
               ExecutorService executePool)

Creates an object to access a HBase table. Shares zookeeper connection and other resources with other OHTable instances created with the same connection instance. Use this constructor when the ExecutorService and HConnection instance are externally managed.

参数:

tableName - Name of the table.

obTableClient - Oceanbase obTableClient to be used.

executePool - ExecutorService to be used.

抛出:

IllegalArgumentException - if the param error

方法详细资料

createDefaultThreadPoolExecutor

public static ThreadPoolExecutor createDefaultThreadPoolExecutor(int coreSize,
                                                                 int maxThreads,
                                                                 long keepAliveTime)

创建默认的线程池 Using the "direct handoff" approach, new threads will only be created if it is necessary and will grow unbounded. This could be bad but in HCM we only create as many Runnables as there are region servers. It means it also scales when new region servers are added.

参数:

coreSize - core size

maxThreads - max threads

keepAliveTime - keep alive time

返回:

ThreadPoolExecutor

getTableName

public byte[] getTableName()

指定者:

getTableName 在接口中 org.apache.hadoop.hbase.client.HTableInterface

getConfiguration

public org.apache.hadoop.conf.Configuration getConfiguration()

指定者:

getConfiguration 在接口中 org.apache.hadoop.hbase.client.HTableInterface

getTableDescriptor

public org.apache.hadoop.hbase.HTableDescriptor getTableDescriptor()

指定者:

getTableDescriptor 在接口中 org.apache.hadoop.hbase.client.HTableInterface

exists

public boolean exists(org.apache.hadoop.hbase.client.Get get)
               throws IOException

Test for the existence of columns in the table, as specified in the Get. This will return true if the Get matches one or more keys, false if not. Be carefully ,this is not a server-side call in real. May be optimized later

指定者:

exists 在接口中 org.apache.hadoop.hbase.client.HTableInterface

参数:

get - the Get

返回:

true if the specified Get matches one or more keys, false if not

抛出:

IOException - e

batch

public void batch(List<? extends org.apache.hadoop.hbase.client.Row> actions,
                  Object[] results)

指定者:

batch 在接口中 org.apache.hadoop.hbase.client.HTableInterface

batch

public Object[] batch(List<? extends org.apache.hadoop.hbase.client.Row> actions)

指定者:

batch 在接口中 org.apache.hadoop.hbase.client.HTableInterface

getKeyValueFromResult

public void getKeyValueFromResult(com.alipay.oceanbase.rpc.protocol.payload.impl.execute.query.AbstractQueryStreamResult clientQueryStreamResult,
                                  List<org.apache.hadoop.hbase.KeyValue> keyValueList,
                                  boolean isTableGroup,
                                  byte[] family)
                           throws Exception

抛出:

Exception

get

public org.apache.hadoop.hbase.client.Result get(org.apache.hadoop.hbase.client.Get get)
                                          throws IOException

指定者:

get 在接口中 org.apache.hadoop.hbase.client.HTableInterface

抛出:

IOException

get

public org.apache.hadoop.hbase.client.Result[] get(List<org.apache.hadoop.hbase.client.Get> gets)
                                            throws IOException

指定者:

get 在接口中 org.apache.hadoop.hbase.client.HTableInterface

抛出:

IOException

getRowOrBefore

public org.apache.hadoop.hbase.client.Result getRowOrBefore(byte[] row,
                                                            byte[] family)

hbase的获取这个rowkey，没有的话就前一个rowkey，不支持

指定者:

getRowOrBefore 在接口中 org.apache.hadoop.hbase.client.HTableInterface

参数:

row - row

family - family

返回:

Result

getScanner

public org.apache.hadoop.hbase.client.ResultScanner getScanner(org.apache.hadoop.hbase.client.Scan scan)
                                                        throws IOException

指定者:

getScanner 在接口中 org.apache.hadoop.hbase.client.HTableInterface

抛出:

IOException

getScanner

public org.apache.hadoop.hbase.client.ResultScanner getScanner(byte[] family)
                                                        throws IOException

指定者:

getScanner 在接口中 org.apache.hadoop.hbase.client.HTableInterface

抛出:

IOException

getScanner

public org.apache.hadoop.hbase.client.ResultScanner getScanner(byte[] family,
                                                               byte[] qualifier)
                                                        throws IOException

指定者:

getScanner 在接口中 org.apache.hadoop.hbase.client.HTableInterface

抛出:

IOException

put

public void put(org.apache.hadoop.hbase.client.Put put)
         throws IOException

指定者:

put 在接口中 org.apache.hadoop.hbase.client.HTableInterface

抛出:

IOException

put

public void put(List<org.apache.hadoop.hbase.client.Put> puts)
         throws IOException

指定者:

put 在接口中 org.apache.hadoop.hbase.client.HTableInterface

抛出:

IOException

checkAndPut

public boolean checkAndPut(byte[] row,
                           byte[] family,
                           byte[] qualifier,
                           byte[] value,
                           org.apache.hadoop.hbase.client.Put put)
                    throws IOException

例如当 key="key001", family = "family", c1="a" 时，才执行 put 操作，该命令是原子的

指定者:

checkAndPut 在接口中 org.apache.hadoop.hbase.client.HTableInterface

参数:

row - row

family - family

qualifier - qualifier

value - value

put - put

返回:

boolean

抛出:

IOException - if failed

delete

public void delete(org.apache.hadoop.hbase.client.Delete delete)
            throws IOException

指定者:

delete 在接口中 org.apache.hadoop.hbase.client.HTableInterface

抛出:

IOException

delete

public void delete(List<org.apache.hadoop.hbase.client.Delete> deletes)
            throws IOException

指定者:

delete 在接口中 org.apache.hadoop.hbase.client.HTableInterface

抛出:

IOException

checkAndDelete

public boolean checkAndDelete(byte[] row,
                              byte[] family,
                              byte[] qualifier,
                              byte[] value,
                              org.apache.hadoop.hbase.client.Delete delete)
                       throws IOException

例如当 key="key001", family = "family", c1="a" 时，才执行 delete 操作，该命令是原子的

指定者:

checkAndDelete 在接口中 org.apache.hadoop.hbase.client.HTableInterface

参数:

row - row

family - family

qualifier - qualifier

value - value

delete - delete

返回:

boolean

抛出:

IOException - if failed

mutateRow

public void mutateRow(org.apache.hadoop.hbase.client.RowMutations rm)

指定者:

mutateRow 在接口中 org.apache.hadoop.hbase.client.HTableInterface

append

public org.apache.hadoop.hbase.client.Result append(org.apache.hadoop.hbase.client.Append append)
                                             throws IOException

例如 key = "key", c1="a"，在c1后面append，使c1="aaa" 原子操作

指定者:

append 在接口中 org.apache.hadoop.hbase.client.HTableInterface

参数:

append - append

返回:

Result

抛出:

IOException - if failed

increment

public org.apache.hadoop.hbase.client.Result increment(org.apache.hadoop.hbase.client.Increment increment)
                                                throws IOException

例如 key = "key", c2=1，在c2后面increment，在c2后面加2，变成 c2=3 原子操作

指定者:

increment 在接口中 org.apache.hadoop.hbase.client.HTableInterface

参数:

increment - increment

返回:

Result

抛出:

IOException - if failed

incrementColumnValue

public long incrementColumnValue(byte[] row,
                                 byte[] family,
                                 byte[] qualifier,
                                 long amount)
                          throws IOException

直接通过 column 名进行 increment 操作

指定者:

incrementColumnValue 在接口中 org.apache.hadoop.hbase.client.HTableInterface

参数:

row - row

family - family

qualifier - qualifier

amount - amount

返回:

long

抛出:

IOException - if failed

incrementColumnValue

public long incrementColumnValue(byte[] row,
                                 byte[] family,
                                 byte[] qualifier,
                                 long amount,
                                 boolean writeToWAL)
                          throws IOException

指定者:

incrementColumnValue 在接口中 org.apache.hadoop.hbase.client.HTableInterface

抛出:

IOException

isAutoFlush

public boolean isAutoFlush()

指定者:

isAutoFlush 在接口中 org.apache.hadoop.hbase.client.HTableInterface

flushCommits

public void flushCommits()
                  throws IOException

指定者:

flushCommits 在接口中 org.apache.hadoop.hbase.client.HTableInterface

抛出:

IOException

close

public void close()
           throws IOException

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

指定者:

close 在接口中 org.apache.hadoop.hbase.client.HTableInterface

抛出:

IOException

lockRow

public org.apache.hadoop.hbase.client.RowLock lockRow(byte[] row)

指定者:

lockRow 在接口中 org.apache.hadoop.hbase.client.HTableInterface

unlockRow

public void unlockRow(org.apache.hadoop.hbase.client.RowLock rl)

指定者:

unlockRow 在接口中 org.apache.hadoop.hbase.client.HTableInterface

coprocessorProxy

public <T extends org.apache.hadoop.hbase.ipc.CoprocessorProtocol> T coprocessorProxy(Class<T> protocol,
                                                                                      byte[] row)

指定者:

coprocessorProxy 在接口中 org.apache.hadoop.hbase.client.HTableInterface

coprocessorExec

public <T extends org.apache.hadoop.hbase.ipc.CoprocessorProtocol,R> Map<byte[],R> coprocessorExec(Class<T> protocol,
                                                                                                   byte[] startKey,
                                                                                                   byte[] endKey,
                                                                                                   org.apache.hadoop.hbase.client.coprocessor.Batch.Call<T,R> callable)

指定者:

coprocessorExec 在接口中 org.apache.hadoop.hbase.client.HTableInterface

coprocessorExec

public <T extends org.apache.hadoop.hbase.ipc.CoprocessorProtocol,R> void coprocessorExec(Class<T> protocol,
                                                                                          byte[] startKey,
                                                                                          byte[] endKey,
                                                                                          org.apache.hadoop.hbase.client.coprocessor.Batch.Call<T,R> callable,
                                                                                          org.apache.hadoop.hbase.client.coprocessor.Batch.Callback<R> callback)

指定者:

coprocessorExec 在接口中 org.apache.hadoop.hbase.client.HTableInterface

setAutoFlush

public void setAutoFlush(boolean autoFlush)

See setAutoFlush(boolean, boolean)

指定者:

setAutoFlush 在接口中 org.apache.hadoop.hbase.client.HTableInterface

参数:

autoFlush - Whether or not to enable 'auto-flush'.

setAutoFlush

public void setAutoFlush(boolean autoFlush,
                         boolean clearBufferOnFail)

Turns 'auto-flush' on or off.

When enabled (default), Put operations don't get buffered/delayed and are immediately executed. Failed operations are not retried. This is slower but safer.

Turning off autoFlush means that multiple Puts will be accepted before any RPC is actually sent to do the write operations. If the application dies before pending writes get flushed to HBase, data will be lost.

When you turn autoFlush off, you should also consider the clearBufferOnFail option. By default, asynchronous Put requests will be retried on failure until successful. However, this can pollute the writeBuffer and slow down batching performance. Additionally, you may want to issue a number of Put requests and call flushCommits() as a barrier. In both use cases, consider setting clearBufferOnFail to true to erase the buffer after flushCommits() has been called, regardless of success.

指定者:

setAutoFlush 在接口中 org.apache.hadoop.hbase.client.HTableInterface

参数:

autoFlush - Whether or not to enable 'auto-flush'.

clearBufferOnFail - Whether to keep Put failures in the writeBuffer

另请参阅:

flushCommits()

getWriteBufferSize

public long getWriteBufferSize()

Returns the maximum size in bytes of the write buffer for this HTable.

The default value comes from the configuration parameter hbase.client.write.buffer.

指定者:

getWriteBufferSize 在接口中 org.apache.hadoop.hbase.client.HTableInterface

返回:

The size of the write buffer in bytes.

setWriteBufferSize

public void setWriteBufferSize(long writeBufferSize)
                        throws IOException

Sets the size of the buffer in bytes.

If the new size is less than the current amount of data in the write buffer, the buffer gets flushed.

指定者:

setWriteBufferSize 在接口中 org.apache.hadoop.hbase.client.HTableInterface

参数:

writeBufferSize - The new write buffer size, in bytes.

抛出:

IOException - if a remote or network exception occurs.

setOperationTimeout

public void setOperationTimeout(int operationTimeout)

setRuntimeBatchExecutor

public void setRuntimeBatchExecutor(ExecutorService runtimeBatchExecutor)

refreshTableEntry

public void refreshTableEntry(String familyString,
                              boolean hasTestLoad)
                       throws Exception

抛出:

Exception

getStartKeys

public byte[][] getStartKeys()
                      throws IOException

抛出:

IOException

getEndKeys

public byte[][] getEndKeys()
                    throws IOException

抛出:

IOException

getStartEndKeys

public org.apache.hadoop.hbase.util.Pair<byte[][],byte[][]> getStartEndKeys()
                                                                     throws IOException

抛出:

IOException