OceanBasePoolDataSource (oceanbase-client 2.4.11 API)

java.lang.Object
- com.oceanbase.jdbc.OceanBaseDataSource
- - com.oceanbase.jdbc.OceanBasePoolDataSource

所有已实现的接口:: Closeable, AutoCloseable, Wrapper, CommonDataSource, ConnectionPoolDataSource, DataSource, XADataSource

public class OceanBasePoolDataSource
extends OceanBaseDataSource
implements ConnectionPoolDataSource, XADataSource, Closeable, AutoCloseable

字段概要
- 从类继承的字段 com.oceanbase.jdbc.OceanBaseDataSource
  connectTimeoutInMs, database, hostname, password, port, url, user

构造器概要

构造器
构造器和说明
`OceanBasePoolDataSource()` Default constructor. hostname will be localhost, port 3306.
`OceanBasePoolDataSource(String url)`
`OceanBasePoolDataSource(String hostname, int port, String database)` Constructor.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`close()` Close datasource.
`int`	`getLoginTimeout()` Gets the maximum time in seconds that this data source can wait while attempting to connect to a database.
`PrintWriter`	`getLogWriter()` Retrieves the log writer for this `DataSource` object.
`int`	`getMaxIdleTime()` Max time a connection can be idle.
`int`	`getMaxPoolSize()` Pool maximum connection size.
`int`	`getMinPoolSize()` Get minimum pool size (pool will grow at creation untile reaching this size).
`Logger`	`getParentLogger()`
`PooledConnection`	`getPooledConnection()` Attempts to establish a physical database connection that can be used as a pooled connection.
`PooledConnection`	`getPooledConnection(String user, String password)` Attempts to establish a physical database connection that can be used as a pooled connection.
`String`	`getPoolName()`
`Integer`	`getPoolValidMinDelay()` If connection has been used in less time than poolValidMinDelay, then no connection validation will be done (0=mean validation every time).
`int`	`getPortNumber()` Returns the port number.
`Boolean`	`getStaticGlobal()`
`protected UrlParser`	`getUrlParser()` For testing purpose only.
`XAConnection`	`getXAConnection()`
`XAConnection`	`getXAConnection(String user, String password)`
`boolean`	`isWrapperFor(Class<?> interfaceOrWrapper)` Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.
`void`	`setDatabaseName(String database)` Sets the database name.
`void`	`setLoginTimeout(int seconds)` Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
`void`	`setLogWriter(PrintWriter out)` Sets the log writer for this `DataSource` object to the given `java.io.PrintWriter` object.
`void`	`setMaxIdleTime(int maxIdleTime)`
`void`	`setMaxPoolSize(int maxPoolSize)`
`void`	`setMinPoolSize(int minPoolSize)`
`void`	`setPassword(String password)` Sets the password.
`void`	`setPoolName(String poolName)`
`void`	`setPoolValidMinDelay(Integer poolValidMinDelay)`
`void`	`setPort(int port)` Sets the database port.
`void`	`setPortNumber(int port)` Sets the port number.
`void`	`setServerName(String serverName)` Sets the server name.
`void`	`setStaticGlobal(Boolean staticGlobal)`
`void`	`setUrl(String url)` Sets the connection string URL.
`void`	`setUser(String user)` Sets the username.
`void`	`testForceMaxIdleTime(int maxIdleTime)` Permit to create test that doesn't wait for maxIdleTime minimum value of 60 seconds. !!
`List<Long>`	`testGetConnectionIdleThreadIds()` Get current idle threads. !!
`Pool`	`testGetPool()` Get pool. !!
`<T> T`	`unwrap(Class<T> iface)` Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.

从类继承的方法 com.oceanbase.jdbc.OceanBaseDataSource
getConnection, getConnection, getDatabaseName, getPort, getServerName, getURL, getUser, getUserName, initialize, setProperties, setURL, setUserName

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

- 构造器详细资料
  - OceanBasePoolDataSource
```
public OceanBasePoolDataSource(String hostname,
                               int port,
                               String database)
```
    Constructor.
    
    参数:
    
    hostname - hostname (ipv4, ipv6, dns name)
    
    port - server port
    
    database - database name
  - OceanBasePoolDataSource
```
public OceanBasePoolDataSource(String url)
```
  - OceanBasePoolDataSource
```
public OceanBasePoolDataSource()
```
    Default constructor. hostname will be localhost, port 3306.
- 方法详细资料
  - setDatabaseName
```
public void setDatabaseName(String database)
                     throws SQLException
```
    Sets the database name.
    
    覆盖:
    
    setDatabaseName 在类中 OceanBaseDataSource
    
    参数:
    
    database - the name of the database
    
    抛出:
    
    SQLException - if error in URL
  - setUser
```
public void setUser(String user)
             throws SQLException
```
    Sets the username.
    
    覆盖:
    
    setUser 在类中 OceanBaseDataSource
    
    参数:
    
    user - the username
    
    抛出:
    
    SQLException - if error in URL
  - setPassword
```
public void setPassword(String password)
                 throws SQLException
```
    Sets the password.
    
    覆盖:
    
    setPassword 在类中 OceanBaseDataSource
    
    参数:
    
    password - the password
    
    抛出:
    
    SQLException - if error in URL
  - setPort
```
public void setPort(int port)
             throws SQLException
```
    Sets the database port.
    
    覆盖:
    
    setPort 在类中 OceanBaseDataSource
    
    参数:
    
    port - the port
    
    抛出:
    
    SQLException - if error in URL
  - getPortNumber
```
public int getPortNumber()
```
    Returns the port number.
    
    覆盖:
    
    getPortNumber 在类中 OceanBaseDataSource
    
    返回:
    
    the port number
  - setPortNumber
```
public void setPortNumber(int port)
                   throws SQLException
```
    Sets the port number.
    
    覆盖:
    
    setPortNumber 在类中 OceanBaseDataSource
    
    参数:
    
    port - the port
    
    抛出:
    
    SQLException - if error in URL
    
    另请参阅:
    
    setPort(int)
  - setUrl
```
public void setUrl(String url)
            throws SQLException
```
    Sets the connection string URL.
    
    覆盖:
    
    setUrl 在类中 OceanBaseDataSource
    
    参数:
    
    url - the connection string
    
    抛出:
    
    SQLException - if error in URL
  - setServerName
```
public void setServerName(String serverName)
                   throws SQLException
```
    Sets the server name.
    
    覆盖:
    
    setServerName 在类中 OceanBaseDataSource
    
    参数:
    
    serverName - the server name
    
    抛出:
    
    SQLException - if error in URL
  - getPooledConnection
```
public PooledConnection getPooledConnection()
                                     throws SQLException
```
    Attempts to establish a physical database connection that can be used as a pooled connection.
    
    指定者:
    
    getPooledConnection 在接口中 ConnectionPoolDataSource
    
    返回:
    
    a PooledConnection object that is a physical connection to the database that this ConnectionPoolDataSource object represents
    
    抛出:
    
    SQLException - if a database access error occurs if the JDBC driver does not support this method
  - getPooledConnection
```
public PooledConnection getPooledConnection(String user,
                                            String password)
                                     throws SQLException
```
    Attempts to establish a physical database connection that can be used as a pooled connection.
    
    指定者:
    
    getPooledConnection 在接口中 ConnectionPoolDataSource
    
    参数:
    
    user - the database user on whose behalf the connection is being made
    
    password - the user's password
    
    返回:
    
    a PooledConnection object that is a physical connection to the database that this ConnectionPoolDataSource object represents
    
    抛出:
    
    SQLException - if a database access error occurs
  - getLogWriter
```
public PrintWriter getLogWriter()
```
    Retrieves the log writer for this DataSource object.
    The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source specific log writer are not printed to the log writer associated with the java.sql.DriverManager class.
    When a DataSource object is created, the log writer is initially null; in other words, the default is for logging to be disabled.
    
    指定者:
    
    getLogWriter 在接口中 CommonDataSource
    
    覆盖:
    
    getLogWriter 在类中 OceanBaseDataSource
    
    返回:
    
    the log writer for this data source or null if logging is disabled
    
    另请参阅:
    
    setLogWriter(java.io.PrintWriter)
  - setLogWriter
```
public void setLogWriter(PrintWriter out)
```
    Sets the log writer for this DataSource object to the given java.io.PrintWriter object.
    The log writer is a character output stream to which all logging and tracing messages for this data source will be printed. This includes messages printed by the methods of this object, messages printed by methods of other objects manufactured by this object, and so on. Messages printed to a data source- specific log writer are not printed to the log writer associated with the java.sql.DriverManager class. When a DataSource object is created the log writer is initially null; in other words, the default is for logging to be disabled.
    
    指定者:
    
    setLogWriter 在接口中 CommonDataSource
    
    覆盖:
    
    setLogWriter 在类中 OceanBaseDataSource
    
    参数:
    
    out - the new log writer; to disable logging, set to null
    
    从以下版本开始:
    
    1.4
    
    另请参阅:
    
    getLogWriter()
  - getLoginTimeout
```
public int getLoginTimeout()
```
    Gets the maximum time in seconds that this data source can wait while attempting to connect to a database. A value of zero means that the timeout is the default system timeout if there is one; otherwise, it means that there is no timeout. When a DataSource object is created, the login timeout is initially zero.
    
    指定者:
    
    getLoginTimeout 在接口中 CommonDataSource
    
    覆盖:
    
    getLoginTimeout 在类中 OceanBaseDataSource
    
    返回:
    
    the data source login time limit
    
    从以下版本开始:
    
    1.4
    
    另请参阅:
    
    setLoginTimeout(int)
  - setLoginTimeout
```
public void setLoginTimeout(int seconds)
                     throws SQLException
```
    Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. When a DataSource object is created, the login timeout is initially zero.
    
    指定者:
    
    setLoginTimeout 在接口中 CommonDataSource
    
    覆盖:
    
    setLoginTimeout 在类中 OceanBaseDataSource
    
    参数:
    
    seconds - the data source login time limit
    
    抛出:
    
    SQLException - if a database access error occurs.
    
    从以下版本开始:
    
    1.4
    
    另请参阅:
    
    getLoginTimeout()
  - unwrap
```
public <T> T unwrap(Class<T> iface)
             throws SQLException
```
    Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.
    If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of calling unwrap recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an SQLException is thrown.
    
    指定者:
    
    unwrap 在接口中 Wrapper
    
    覆盖:
    
    unwrap 在类中 OceanBaseDataSource
    
    参数:
    
    iface - A Class defining an interface that the result must implement.
    
    返回:
    
    an object that implements the interface. May be a proxy for the actual implementing object.
    
    抛出:
    
    SQLException - If no object found that implements the interface
    
    从以下版本开始:
    
    1.6
  - isWrapperFor
```
public boolean isWrapperFor(Class<?> interfaceOrWrapper)
                     throws SQLException
```
    Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively calling isWrapperFor on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared to unwrap so that callers can use this method to avoid expensive unwrap calls that may fail. If this method returns true then calling unwrap with the same argument should succeed.
    
    指定者:
    
    isWrapperFor 在接口中 Wrapper
    
    覆盖:
    
    isWrapperFor 在类中 OceanBaseDataSource
    
    参数:
    
    interfaceOrWrapper - a Class defining an interface.
    
    返回:
    
    true if this implements the interface or directly or indirectly wraps an object that does.
    
    抛出:
    
    SQLException - if an error occurs while determining whether this is a wrapper for an object with the given interface.
    
    从以下版本开始:
    
    1.6
  - getXAConnection
```
public XAConnection getXAConnection()
                             throws SQLException
```
    指定者:
    
    getXAConnection 在接口中 XADataSource
    
    覆盖:
    
    getXAConnection 在类中 OceanBaseDataSource
    
    抛出:
    
    SQLException
  - getXAConnection
```
public XAConnection getXAConnection(String user,
                                    String password)
                             throws SQLException
```
    指定者:
    
    getXAConnection 在接口中 XADataSource
    
    覆盖:
    
    getXAConnection 在类中 OceanBaseDataSource
    
    抛出:
    
    SQLException
  - getParentLogger
```
public Logger getParentLogger()
```
    指定者:
    
    getParentLogger 在接口中 CommonDataSource
    
    覆盖:
    
    getParentLogger 在类中 OceanBaseDataSource
  - getUrlParser
```
protected UrlParser getUrlParser()
```
    For testing purpose only.
    
    覆盖:
    
    getUrlParser 在类中 OceanBaseDataSource
    
    返回:
    
    current url parser.
  - getPoolName
```
public String getPoolName()
```
  - setPoolName
```
public void setPoolName(String poolName)
                 throws SQLException
```
    抛出:
    
    SQLException
  - getMaxPoolSize
```
public int getMaxPoolSize()
```
    Pool maximum connection size.
    
    返回:
    
    current value.
  - setMaxPoolSize
```
public void setMaxPoolSize(int maxPoolSize)
                    throws SQLException
```
    抛出:
    
    SQLException
  - getMinPoolSize
```
public int getMinPoolSize()
```
    Get minimum pool size (pool will grow at creation untile reaching this size). Null mean use the pool maximum pool size.
    
    返回:
    
    current value.
  - setMinPoolSize
```
public void setMinPoolSize(int minPoolSize)
                    throws SQLException
```
    抛出:
    
    SQLException
  - getMaxIdleTime
```
public int getMaxIdleTime()
```
    Max time a connection can be idle.
    
    返回:
    
    current value.
  - setMaxIdleTime
```
public void setMaxIdleTime(int maxIdleTime)
                    throws SQLException
```
    抛出:
    
    SQLException
  - getStaticGlobal
```
public Boolean getStaticGlobal()
```
  - setStaticGlobal
```
public void setStaticGlobal(Boolean staticGlobal)
```
  - getPoolValidMinDelay
```
public Integer getPoolValidMinDelay()
```
    If connection has been used in less time than poolValidMinDelay, then no connection validation will be done (0=mean validation every time).
    
    返回:
    
    current value of poolValidMinDelay
  - setPoolValidMinDelay
```
public void setPoolValidMinDelay(Integer poolValidMinDelay)
```
  - close
```
public void close()
```
    Close datasource.
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
  - testGetConnectionIdleThreadIds
```
public List<Long> testGetConnectionIdleThreadIds()
```
    Get current idle threads. !! For testing purpose only !!
    
    返回:
    
    current thread id's
  - testForceMaxIdleTime
```
public void testForceMaxIdleTime(int maxIdleTime)
                          throws SQLException
```
    Permit to create test that doesn't wait for maxIdleTime minimum value of 60 seconds. !! For testing purpose only !!
    
    参数:
    
    maxIdleTime - forced value of maxIdleTime option.
    
    抛出:
    
    SQLException - if connection string has error
  - testGetPool
```
public Pool testGetPool()
```
    Get pool. !! For testing purpose only !!
    
    返回:
    
    pool

类 OceanBasePoolDataSource

字段概要

从类继承的字段 com.oceanbase.jdbc.OceanBaseDataSource

构造器概要

方法概要

从类继承的方法 com.oceanbase.jdbc.OceanBaseDataSource

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

构造器详细资料

OceanBasePoolDataSource

OceanBasePoolDataSource

OceanBasePoolDataSource

方法详细资料

setDatabaseName

setUser

setPassword

setPort

getPortNumber

setPortNumber

setUrl

setServerName

getPooledConnection

getPooledConnection

getLogWriter

setLogWriter

getLoginTimeout

setLoginTimeout

unwrap

isWrapperFor

getXAConnection

getXAConnection

getParentLogger

getUrlParser

getPoolName

setPoolName

getMaxPoolSize

setMaxPoolSize

getMinPoolSize

setMinPoolSize

getMaxIdleTime

setMaxIdleTime

getStaticGlobal

setStaticGlobal

getPoolValidMinDelay

setPoolValidMinDelay

close

testGetConnectionIdleThreadIds

testForceMaxIdleTime

testGetPool