OHTablePool (com.oceanbase:obkv-hbase-client 2.1.0 API)

java.lang.Object
- com.alipay.oceanbase.hbase.OHTablePool

所有已实现的接口:: Closeable, AutoCloseable

public class OHTablePool
extends Object
implements Closeable

嵌套类概要

嵌套类
限定符和类型类和说明

class OHTablePool.PooledOHTable
A proxy class that implements HTableInterface.close method to return the wrapped table back to the table pool

嵌套类
限定符和类型	类和说明
`class`	`OHTablePool.PooledOHTable` A proxy class that implements HTableInterface.close method to return the wrapped table back to the table pool

构造器概要

构造器
构造器和说明
`OHTablePool()` Default Constructor.
`OHTablePool(org.apache.hadoop.conf.Configuration config, int maxSize)` Constructor to set maximum versions and use the specified configuration.
`OHTablePool(org.apache.hadoop.conf.Configuration config, int maxSize, OHTableFactory tableFactory)` Constructor to set maximum versions and use the specified configuration and table factory.
`OHTablePool(org.apache.hadoop.conf.Configuration config, int maxSize, OHTableFactory tableFactory, ExecutorService createTableExecutor, org.apache.hadoop.hbase.util.PoolMap.PoolType poolType)`
`OHTablePool(org.apache.hadoop.conf.Configuration config, int maxSize, OHTableFactory tableFactory, org.apache.hadoop.hbase.util.PoolMap.PoolType poolType)` Constructor to set maximum versions and use the specified configuration, table factory and pool type.
`OHTablePool(org.apache.hadoop.conf.Configuration config, int maxSize, org.apache.hadoop.hbase.util.PoolMap.PoolType poolType)` Constructor to set maximum versions and use the specified configuration and pool type.

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`close()` Closes all the HTable instances , belonging to all tables in the table pool.
`void`	`closeTablePool(byte[] tableName)` See `closeTablePool(String)`.
`void`	`closeTablePool(String tableName)` Closes all the HTable instances , belonging to the given table, in the table pool.
`protected org.apache.hadoop.hbase.client.Table`	`createHTable(String tableName)`
`boolean`	`getAutoFlush(String tableName)` Gets the autoFlush flag for the specified tables in this pool.
`boolean`	`getClearBufferOnFail(String tableName)` Gets the flag of ClearBufferOnFail for the specified tables in this pool.
`String`	`getDatabase(String tableName)` Gets the ODP database name for the specified tables in this pool.
`String`	`getFullUserName(String tableName)` Gets the username for the specified table in this pool.
`String`	`getOdpAddr(String tableName)` Gets the ODP address for the specified tables in this pool.
`boolean`	`getOdpMode(String tableName)` Gets the ODP mode for the specified tables in this pool.
`int`	`getOdpPort(String tableName)` Gets the ODP port for the specified tables in this pool.
`int`	`getOperationTimeout(String tableName)` Gets the operation timeout for the specified tables in this pool.
`String`	`getOriginTableName()`
`String`	`getParamUrl(String tableName)` Gets the param url for the specified table in this pool.
`String`	`getPassword(String tableName)` Gets the password for the specified table in this pool.
`ExecutorService`	`getRuntimeBatchExecutor(String tableName)`
`String`	`getSysPassword(String tableName)` Gets the sys user password for the specified table in this pool.
`String`	`getSysUserName(String tableName)` Gets the sys username for the specified table in this pool.
`org.apache.hadoop.hbase.client.Table`	`getTable(byte[] tableName)` Get a reference to the specified table from the pool.
`org.apache.hadoop.hbase.client.Table`	`getTable(String tableName)` Get a reference to the specified table from the pool.
`byte[]`	`getTableAttribute(String tableName, String attributeName)`
`Object`	`getTableExtendAttribute(String tableName, String attributeName)`
`long`	`getWriteBufferSize(String tableName)` Get the maximum size in bytes of the write buffer for the specified tables in this pool.
`void`	`putTable(org.apache.hadoop.hbase.client.Table table)` 已过时。
`void`	`refreshTableEntry(String tableName, String family, boolean hasTestLoad)`
`void`	`setAutoFlush(String tableName, boolean autoFlush)` See `setAutoFlush(String, boolean, boolean)`
`void`	`setAutoFlush(String tableName, boolean autoFlush, boolean clearBufferOnFail)` Sets the autoFlush flag for the specified tables in this pool.
`void`	`setDatabase(String tableName, String database)` Sets the ODP database name for the specified tables in this pool.
`void`	`setFullUserName(String tableName, String fullUserName)` See `OHConstants.HBASE_OCEANBASE_FULL_USER_NAME`
`void`	`setOdpAddr(String tableName, String odpAddr)` Sets the ODP address for the specified tables in this pool.
`void`	`setOdpMode(String tableName, boolean odpMode)` Sets the ODP mode for the specified tables in this pool.
`void`	`setOdpPort(String tableName, int odpPort)` Sets the ODP port for the specified tables in this pool.
`void`	`setOperationTimeout(String tableName, int operationTimeout)` Sets the operation timeout for the specified tables in this pool.
`void`	`setParamUrl(String tableName, String paramUrl)` See `OHConstants.HBASE_OCEANBASE_PARAM_URL`
`void`	`setPassword(String tableName, String password)` See `OHConstants.HBASE_OCEANBASE_PASSWORD`
`void`	`setRuntimeBatchExecutor(String tableName, ExecutorService runtimeBatchExecutor)`
`void`	`setSysPassword(String tableName, String sysPassword)` See `OHConstants.HBASE_OCEANBASE_SYS_PASSWORD`
`void`	`setSysUserName(String tableName, String sysUserName)` See `OHConstants.HBASE_OCEANBASE_SYS_USER_NAME`
`void`	`setWriteBufferSize(String tableName, long writeBufferSize)` Sets the size of the buffer in bytes for the specified tables in this pool.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - OHTablePool
```
public OHTablePool()
```
    Default Constructor. Default HBaseConfiguration and no limit on pool size.
  - OHTablePool
```
public OHTablePool(org.apache.hadoop.conf.Configuration config,
                   int maxSize)
```
    Constructor to set maximum versions and use the specified configuration.
    
    参数:
    
    config - configuration
    
    maxSize - maximum number of references to keep for each table
  - OHTablePool
```
public OHTablePool(org.apache.hadoop.conf.Configuration config,
                   int maxSize,
                   OHTableFactory tableFactory)
```
    Constructor to set maximum versions and use the specified configuration and table factory.
    
    参数:
    
    config - configuration
    
    maxSize - maximum number of references to keep for each table
    
    tableFactory - table factory
  - OHTablePool
```
public OHTablePool(org.apache.hadoop.conf.Configuration config,
                   int maxSize,
                   org.apache.hadoop.hbase.util.PoolMap.PoolType poolType)
```
    Constructor to set maximum versions and use the specified configuration and pool type.
    
    参数:
    
    config - configuration
    
    maxSize - maximum number of references to keep for each table
    
    poolType - pool type which is one of PoolMap.PoolType#Reusable or PoolMap.PoolType#ThreadLocal
  - OHTablePool
```
public OHTablePool(org.apache.hadoop.conf.Configuration config,
                   int maxSize,
                   OHTableFactory tableFactory,
                   org.apache.hadoop.hbase.util.PoolMap.PoolType poolType)
```
    Constructor to set maximum versions and use the specified configuration, table factory and pool type. The HTablePool supports the PoolMap.PoolType#Reusable and PoolMap.PoolType#ThreadLocal. If the pool type is null or not one of those two values, then it will default to PoolMap.PoolType#Reusable.
    
    参数:
    
    config - configuration
    
    maxSize - maximum number of references to keep for each table
    
    tableFactory - table factory
    
    poolType - pool type which is one of PoolMap.PoolType#Reusable or PoolMap.PoolType#ThreadLocal
  - OHTablePool
```
public OHTablePool(org.apache.hadoop.conf.Configuration config,
                   int maxSize,
                   OHTableFactory tableFactory,
                   ExecutorService createTableExecutor,
                   org.apache.hadoop.hbase.util.PoolMap.PoolType poolType)
```
- 方法详细资料
  - getTable
```
public org.apache.hadoop.hbase.client.Table getTable(String tableName)
```
    Get a reference to the specified table from the pool.
    
    参数:
    
    tableName - table name
    
    返回:
    
    a reference to the specified table
    
    抛出:
    
    RuntimeException - if there is a problem instantiating the HTable
  - getTable
```
public org.apache.hadoop.hbase.client.Table getTable(byte[] tableName)
```
    Get a reference to the specified table from the pool. Create a new one if one is not available.
    
    参数:
    
    tableName - table name
    
    返回:
    
    a reference to the specified table
    
    抛出:
    
    RuntimeException - if there is a problem instantiating the HTable
  - putTable
```
public void putTable(org.apache.hadoop.hbase.client.Table table)
              throws IOException
```
    已过时。
    
    This method is not needed anymore, clients should call HTableInterface.close() rather than returning the tables to the pool
    
    参数:
    
    table - the proxy table user got from pool
    
    抛出:
    
    IOException - if failed
  - createHTable
```
protected org.apache.hadoop.hbase.client.Table createHTable(String tableName)
```
  - closeTablePool
```
public void closeTablePool(String tableName)
                    throws IOException
```
    Closes all the HTable instances , belonging to the given table, in the table pool.
    
    参数:
    
    tableName - table name
    
    抛出:
    
    IOException - if failed
  - closeTablePool
```
public void closeTablePool(byte[] tableName)
                    throws IOException
```
    See closeTablePool(String).
    
    参数:
    
    tableName - table name
    
    抛出:
    
    IOException - if failed
  - close
```
public void close()
           throws IOException
```
    Closes all the HTable instances , belonging to all tables in the table pool. Note: this is a 'shutdown' of all the table pools.
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    抛出:
    
    IOException
  - setParamUrl
```
public void setParamUrl(String tableName,
                        String paramUrl)
```
    See OHConstants.HBASE_OCEANBASE_PARAM_URL
    
    参数:
    
    tableName - table name
    
    paramUrl - the table root server http url
  - getParamUrl
```
public String getParamUrl(String tableName)
```
    Gets the param url for the specified table in this pool.
    
    参数:
    
    tableName - table name
    
    返回:
    
    the table root server http url
  - setFullUserName
```
public void setFullUserName(String tableName,
                            String fullUserName)
```
    See OHConstants.HBASE_OCEANBASE_FULL_USER_NAME
    
    参数:
    
    tableName - table name
    
    fullUserName - the table login username
  - getFullUserName
```
public String getFullUserName(String tableName)
```
    Gets the username for the specified table in this pool.
    
    参数:
    
    tableName - table name
    
    返回:
    
    the table login username
  - setPassword
```
public void setPassword(String tableName,
                        String password)
```
    See OHConstants.HBASE_OCEANBASE_PASSWORD
    
    参数:
    
    tableName - table name
    
    password - the table login password
  - getPassword
```
public String getPassword(String tableName)
```
    Gets the password for the specified table in this pool.
    
    参数:
    
    tableName - table name
    
    返回:
    
    the table login password
  - setSysUserName
```
public void setSysUserName(String tableName,
                           String sysUserName)
```
    See OHConstants.HBASE_OCEANBASE_SYS_USER_NAME
    
    参数:
    
    tableName - table name
    
    sysUserName - the sys username
  - getSysUserName
```
public String getSysUserName(String tableName)
```
    Gets the sys username for the specified table in this pool.
    
    参数:
    
    tableName - table name
    
    返回:
    
    the sys username
  - setSysPassword
```
public void setSysPassword(String tableName,
                           String sysPassword)
```
    See OHConstants.HBASE_OCEANBASE_SYS_PASSWORD
    
    参数:
    
    tableName - table name
    
    sysPassword - the sys user password
  - getSysPassword
```
public String getSysPassword(String tableName)
```
    Gets the sys user password for the specified table in this pool.
    
    参数:
    
    tableName - table name
    
    返回:
    
    the sys user password
  - setAutoFlush
```
public void setAutoFlush(String tableName,
                         boolean autoFlush)
```
    See setAutoFlush(String, boolean, boolean)
    
    参数:
    
    tableName - table name
    
    autoFlush - Whether or not to enable 'auto-flush'.
  - setAutoFlush
```
public void setAutoFlush(String tableName,
                         boolean autoFlush,
                         boolean clearBufferOnFail)
```
    Sets the autoFlush flag for the specified tables in this pool.
    
    参数:
    
    tableName - table name
    
    autoFlush - Whether or not to enable 'auto-flush'.
    
    clearBufferOnFail - Whether to keep Put failures in the writeBuffer
  - getAutoFlush
```
public boolean getAutoFlush(String tableName)
```
    Gets the autoFlush flag for the specified tables in this pool.
    
    参数:
    
    tableName - table name
    
    返回:
    
    true if enable 'auto-flush' for specified table
  - getClearBufferOnFail
```
public boolean getClearBufferOnFail(String tableName)
```
    Gets the flag of ClearBufferOnFail for the specified tables in this pool.
    
    参数:
    
    tableName - table name
    
    返回:
    
    true if keep Put failures in the writeBuffer
  - setWriteBufferSize
```
public void setWriteBufferSize(String tableName,
                               long writeBufferSize)
                        throws IOException
```
    Sets the size of the buffer in bytes for the specified tables in this pool.
    
    参数:
    
    tableName - table name
    
    writeBufferSize - The new write buffer size, in bytes.
    
    抛出:
    
    IOException - if a remote or network exception occurs.
  - getWriteBufferSize
```
public long getWriteBufferSize(String tableName)
```
    Get the maximum size in bytes of the write buffer for the specified tables in this pool.
    
    参数:
    
    tableName - table name
    
    返回:
    
    The size of the write buffer in bytes.
  - getOriginTableName
```
public String getOriginTableName()
```
  - setOperationTimeout
```
public void setOperationTimeout(String tableName,
                                int operationTimeout)
```
    Sets the operation timeout for the specified tables in this pool.
    
    参数:
    
    tableName - table name
    
    operationTimeout - timeout
  - refreshTableEntry
```
public void refreshTableEntry(String tableName,
                              String family,
                              boolean hasTestLoad)
                       throws Exception
```
    抛出:
    
    Exception
  - getOperationTimeout
```
public int getOperationTimeout(String tableName)
```
    Gets the operation timeout for the specified tables in this pool.
    
    参数:
    
    tableName - table name
    
    返回:
    
    the operation timeout
  - setOdpAddr
```
public void setOdpAddr(String tableName,
                       String odpAddr)
```
    Sets the ODP address for the specified tables in this pool.
    
    参数:
    
    tableName - table name
    
    odpAddr - ODP address
  - getOdpAddr
```
public String getOdpAddr(String tableName)
```
    Gets the ODP address for the specified tables in this pool.
    
    参数:
    
    tableName - table name
    
    返回:
    
    the ODP address
  - setOdpPort
```
public void setOdpPort(String tableName,
                       int odpPort)
```
    Sets the ODP port for the specified tables in this pool.
    
    参数:
    
    tableName - table name
    
    odpPort - ODP port
  - getOdpPort
```
public int getOdpPort(String tableName)
```
    Gets the ODP port for the specified tables in this pool.
    
    参数:
    
    tableName - table name
    
    返回:
    
    the ODP port
  - setOdpMode
```
public void setOdpMode(String tableName,
                       boolean odpMode)
```
    Sets the ODP mode for the specified tables in this pool.
    
    参数:
    
    tableName - table name
    
    odpMode - ODP mode
  - getOdpMode
```
public boolean getOdpMode(String tableName)
```
    Gets the ODP mode for the specified tables in this pool.
    
    参数:
    
    tableName - table name
    
    返回:
    
    the ODP mode
  - setDatabase
```
public void setDatabase(String tableName,
                        String database)
```
    Sets the ODP database name for the specified tables in this pool.
    
    参数:
    
    tableName - table name
    
    database - ODP database name
  - getDatabase
```
public String getDatabase(String tableName)
```
    Gets the ODP database name for the specified tables in this pool.
    
    参数:
    
    tableName - table name
    
    返回:
    
    the ODP database name
  - getTableAttribute
```
public byte[] getTableAttribute(String tableName,
                                String attributeName)
```
  - getTableExtendAttribute
```
public Object getTableExtendAttribute(String tableName,
                                      String attributeName)
```
  - setRuntimeBatchExecutor
```
public void setRuntimeBatchExecutor(String tableName,
                                    ExecutorService runtimeBatchExecutor)
```
  - getRuntimeBatchExecutor
```
public ExecutorService getRuntimeBatchExecutor(String tableName)
```

类 OHTablePool

嵌套类概要

构造器概要

方法概要

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

构造器详细资料

OHTablePool

OHTablePool

OHTablePool

OHTablePool

OHTablePool

OHTablePool

方法详细资料

getTable

getTable

putTable

createHTable

closeTablePool

closeTablePool

close

setParamUrl

getParamUrl

setFullUserName

getFullUserName

setPassword

getPassword

setSysUserName

getSysUserName

setSysPassword

getSysPassword

setAutoFlush

setAutoFlush

getAutoFlush

getClearBufferOnFail

setWriteBufferSize

getWriteBufferSize

getOriginTableName

setOperationTimeout

refreshTableEntry

getOperationTimeout

setOdpAddr

getOdpAddr

setOdpPort

getOdpPort

setOdpMode

getOdpMode

setDatabase

getDatabase

getTableAttribute

getTableExtendAttribute

setRuntimeBatchExecutor

getRuntimeBatchExecutor