com.alipay.oceanbase.hbase

类 OHTableClient

java.lang.Object

com.alipay.oceanbase.hbase.OHTableClient

所有已实现的接口:

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

public class OHTableClient
extends Object
implements org.apache.hadoop.hbase.client.HTableInterface, Lifecycle

构造器概要

构造器

构造器和说明
OHTableClient(String tableNameString, org.apache.hadoop.conf.Configuration conf) The constructor.

方法概要

限定符和类型	方法和说明
org.apache.hadoop.hbase.client.Result	append(org.apache.hadoop.hbase.client.Append append)
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)
boolean	checkAndPut(byte[] row, byte[] family, byte[] qualifier, byte[] value, org.apache.hadoop.hbase.client.Put put)
void	close() Closes this resource, relinquishing any underlying resources.
<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)
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)
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()
org.apache.hadoop.hbase.client.Result	getRowOrBefore(byte[] row, byte[] family)
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()
String	getTableNameString()
long	getWriteBufferSize()
org.apache.hadoop.hbase.client.Result	increment(org.apache.hadoop.hbase.client.Increment increment)
long	incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount)
long	incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount, boolean writeToWAL)
void	init() Initial the OHTableClient, must be init before use.
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)
void	setAutoFlush(boolean autoFlush, boolean clearBufferOnFail)
void	setRuntimeBatchExecutor(ExecutorService runtimeBatchExecutor)
void	setTableNameString(String tableNameString)
void	setWriteBufferSize(long writeBufferSize)
void	unlockRow(org.apache.hadoop.hbase.client.RowLock rl)

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

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

构造器详细资料

OHTableClient

public OHTableClient(String tableNameString,
                     org.apache.hadoop.conf.Configuration conf)

The constructor.

NOTE: Required parameters in conf:

      Configuration conf = new Configuration();
      conf.set(HBASE_OCEANBASE_PARAM_URL, "http://param_url.com?database=test");
      conf.set(HBASE_OCEANBASE_FULL_USER_NAME, "username");
      conf.set(HBASE_OCEANBASE_PASSWORD, "password");
      conf.set(HBASE_OCEANBASE_SYS_USER_NAME, "sys_user_name");
      conf.set(HBASE_OCEANBASE_SYS_PASSWORD, "sys_password");

参数:

tableNameString - table name

conf - configure

方法详细资料

setRuntimeBatchExecutor

public void setRuntimeBatchExecutor(ExecutorService runtimeBatchExecutor)

init

public void init()
          throws Exception

Initial the OHTableClient, must be init before use.

指定者:

init 在接口中 Lifecycle

抛出:

Exception - if init OHTable failed

close

public void close()
           throws IOException

从接口复制的说明: Lifecycle

Closes this resource, relinquishing any underlying resources.

While this interface method is declared to throw Exception, implementers are strongly encouraged to declare concrete implementations of the close method to throw more specific exceptions, or to throw no exception at all if the close operation cannot fail.

Cases where the close operation may fail require careful attention by implementers. It is strongly advised to relinquish the underlying resources and to internally mark the resource as closed, prior to throwing the exception. The close method is unlikely to be invoked more than once and so this ensures that the resources are released in a timely manner. Furthermore it reduces problems that could arise when the resource wraps, or is wrapped, by another resource.

Implementers of this interface are also strongly advised to not have the close method throw InterruptedException. This exception interacts with a thread's interrupted status, and runtime misbehavior is likely to occur if an InterruptedException is suppressed. More generally, if it would cause problems for an exception to be suppressed, the AutoCloseable.close method should not throw it.

Note that unlike the close method of Closeable, this close method is not required to be idempotent. In other words, calling this close method more than once may have some visible side effect, unlike Closeable.close which is required to have no effect if called more than once. However, implementers of this interface are strongly encouraged to make their close methods idempotent.

指定者:

close 在接口中 Lifecycle

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

指定者:

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

抛出:

IOException

lockRow

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

指定者:

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

抛出:

IOException

unlockRow

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

指定者:

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

抛出:

IOException

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)
                                                                                            throws IOException,
                                                                                                   Throwable

指定者:

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

抛出:

IOException

Throwable

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)
                                                                                   throws IOException,
                                                                                          Throwable

指定者:

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

抛出:

IOException

Throwable

setAutoFlush

public void setAutoFlush(boolean autoFlush)

指定者:

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

setAutoFlush

public void setAutoFlush(boolean autoFlush,
                         boolean clearBufferOnFail)

指定者:

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

getWriteBufferSize

public long getWriteBufferSize()

指定者:

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

setWriteBufferSize

public void setWriteBufferSize(long writeBufferSize)
                        throws IOException

指定者:

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

抛出:

IOException

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()
                                                            throws IOException

指定者:

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

抛出:

IOException

exists

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

指定者:

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

抛出:

IOException

batch

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

指定者:

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

抛出:

IOException

InterruptedException

batch

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

指定者:

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

抛出:

IOException

InterruptedException

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)
                                                     throws IOException

指定者:

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

抛出:

IOException

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

指定者:

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

抛出:

IOException

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

指定者:

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

抛出:

IOException

mutateRow

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

指定者:

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

抛出:

IOException

append

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

指定者:

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

抛出:

IOException

increment

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

指定者:

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

抛出:

IOException

incrementColumnValue

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

指定者:

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

抛出:

IOException

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

getTableNameString

public String getTableNameString()

setTableNameString

public void setTableNameString(String tableNameString)

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