OceanBaseDataSource (oceanbase-client 2.4.11 API)

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

所有已实现的接口:

Wrapper, CommonDataSource, DataSource, XADataSource

直接已知子类:

OceanBasePoolDataSource
```
public class OceanBaseDataSource
extends Object
implements DataSource, XADataSource
```

字段概要

字段
限定符和类型	字段和说明
`protected Integer`	`connectTimeoutInMs`
`protected String`	`database`
`protected String`	`hostname`
`protected String`	`password`
`protected Integer`	`port`
`protected String`	`url`
`protected String`	`user`

构造器概要

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

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`Connection`	`getConnection()` Attempts to establish a connection with the data source that this `DataSource` object represents.
`Connection`	`getConnection(String username, String password)` Attempts to establish a connection with the data source that this `DataSource` object represents.
`String`	`getDatabaseName()` Gets the name of the database.
`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.
`Logger`	`getParentLogger()`
`int`	`getPort()` Returns the port number.
`int`	`getPortNumber()` Returns the port number.
`String`	`getServerName()` Returns the name of the database server.
`String`	`getURL()` Returns the URL for this connection
`protected UrlParser`	`getUrlParser()` For testing purpose only.
`String`	`getUser()` Gets the username.
`String`	`getUserName()` Gets the username.
`XAConnection`	`getXAConnection()`
`XAConnection`	`getXAConnection(String user, String password)`
`protected void`	`initialize()`
`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`	`setPassword(String password)` Sets the password.
`void`	`setPort(int port)` Sets the database port.
`void`	`setPortNumber(int port)` Sets the port number.
`void`	`setProperties(String properties)` 已过时。
`void`	`setServerName(String serverName)` Sets the server name.
`void`	`setUrl(String url)` Sets the connection string URL.
`void`	`setURL(String url)` Sets the URL for this connection
`void`	`setUser(String user)` Sets the username.
`void`	`setUserName(String userName)` Sets the username.
`<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.

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

- 字段详细资料
  - hostname
```
protected String hostname
```
  - port
```
protected Integer port
```
  - connectTimeoutInMs
```
protected Integer connectTimeoutInMs
```
  - database
```
protected String database
```
  - url
```
protected String url
```
  - user
```
protected String user
```
  - password
```
protected String password
```
- 构造器详细资料
  - OceanBaseDataSource
```
public OceanBaseDataSource(String hostname,
                           int port,
                           String database)
```
    Constructor.
    
    参数:
    
    hostname - hostname (ipv4, ipv6, dns name)
    
    port - server port
    
    database - database name
  - OceanBaseDataSource
```
public OceanBaseDataSource(String url)
```
  - OceanBaseDataSource
```
public OceanBaseDataSource()
```
    Default constructor. hostname will be localhost, port 3306.
- 方法详细资料
  - getDatabaseName
```
public String getDatabaseName()
```
    Gets the name of the database.
    
    返回:
    
    the name of the database for this data source
  - setDatabaseName
```
public void setDatabaseName(String database)
                     throws SQLException
```
    Sets the database name.
    
    参数:
    
    database - the name of the database
    
    抛出:
    
    SQLException - if connection information are erroneous
  - getUser
```
public String getUser()
```
    Gets the username.
    
    返回:
    
    the username to use when connecting to the database
  - setUser
```
public void setUser(String user)
             throws SQLException
```
    Sets the username.
    
    参数:
    
    user - the username
    
    抛出:
    
    SQLException - if connection information are erroneous
  - getUserName
```
public String getUserName()
```
    Gets the username.
    
    返回:
    
    the username to use when connecting to the database
  - setUserName
```
public void setUserName(String userName)
                 throws SQLException
```
    Sets the username.
    
    参数:
    
    userName - the username
    
    抛出:
    
    SQLException - if connection information are erroneous
  - setPassword
```
public void setPassword(String password)
                 throws SQLException
```
    Sets the password.
    
    参数:
    
    password - the password
    
    抛出:
    
    SQLException - if connection information are erroneous
  - getPort
```
public int getPort()
```
    Returns the port number.
    
    返回:
    
    the port number
  - setPort
```
public void setPort(int port)
             throws SQLException
```
    Sets the database port.
    
    参数:
    
    port - the port
    
    抛出:
    
    SQLException - if connection information are erroneous
  - getPortNumber
```
public int getPortNumber()
```
    Returns the port number.
    
    返回:
    
    the port number
  - setPortNumber
```
public void setPortNumber(int port)
                   throws SQLException
```
    Sets the port number.
    
    参数:
    
    port - the port
    
    抛出:
    
    SQLException - if connection information are erroneous
    
    另请参阅:
    
    setPort(int)
  - setProperties
```
@Deprecated
public void setProperties(String properties)
                               throws SQLException
```
    已过时。
    
    抛出:
    
    SQLException
  - setUrl
```
public void setUrl(String url)
            throws SQLException
```
    Sets the connection string URL.
    
    参数:
    
    url - the connection string
    
    抛出:
    
    SQLException - if error in URL
  - getServerName
```
public String getServerName()
```
    Returns the name of the database server.
    
    返回:
    
    the name of the database server
  - setServerName
```
public void setServerName(String serverName)
                   throws SQLException
```
    Sets the server name.
    
    参数:
    
    serverName - the server name
    
    抛出:
    
    SQLException - if connection information are erroneous
  - getConnection
```
public Connection getConnection()
                         throws SQLException
```
    Attempts to establish a connection with the data source that this DataSource object represents.
    
    指定者:
    
    getConnection 在接口中 DataSource
    
    返回:
    
    a connection to the data source
    
    抛出:
    
    SQLException - if a database access error occurs
  - getConnection
```
public Connection getConnection(String username,
                                String password)
                         throws SQLException
```
    Attempts to establish a connection with the data source that this DataSource object represents.
    
    指定者:
    
    getConnection 在接口中 DataSource
    
    参数:
    
    username - the database user on whose behalf the connection is being made
    
    password - the user's password
    
    返回:
    
    a connection to the data source
    
    抛出:
    
    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
    
    返回:
    
    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
    
    参数:
    
    out - the new log writer; to disable logging, set to null
    
    另请参阅:
    
    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
    
    返回:
    
    the data source login time limit
    
    另请参阅:
    
    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
    
    参数:
    
    seconds - the data source login time limit
    
    抛出:
    
    SQLException
    
    另请参阅:
    
    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
    
    参数:
    
    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
    
    参数:
    
    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.
  - getXAConnection
```
public XAConnection getXAConnection()
                             throws SQLException
```
    指定者:
    
    getXAConnection 在接口中 XADataSource
    
    抛出:
    
    SQLException
  - getXAConnection
```
public XAConnection getXAConnection(String user,
                                    String password)
                             throws SQLException
```
    指定者:
    
    getXAConnection 在接口中 XADataSource
    
    抛出:
    
    SQLException
  - getParentLogger
```
public Logger getParentLogger()
```
    指定者:
    
    getParentLogger 在接口中 CommonDataSource
  - getUrlParser
```
protected UrlParser getUrlParser()
```
    For testing purpose only.
    
    返回:
    
    current url parser.
  - initialize
```
protected void initialize()
                   throws SQLException
```
    抛出:
    
    SQLException
  - setURL
```
public void setURL(String url)
            throws SQLException
```
    Sets the URL for this connection
    
    参数:
    
    url - the URL for this connection
    
    抛出:
    
    SQLException
  - getURL
```
public String getURL()
```
    Returns the URL for this connection
    
    返回:
    
    the URL for this connection

类 OceanBaseDataSource

字段概要

构造器概要

方法概要

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

字段详细资料

hostname

port

connectTimeoutInMs

database

url

user

password

构造器详细资料

OceanBaseDataSource

OceanBaseDataSource

OceanBaseDataSource

方法详细资料

getDatabaseName

setDatabaseName

getUser

setUser

getUserName

setUserName

setPassword

getPort

setPort

getPortNumber

setPortNumber

setProperties

setUrl

getServerName

setServerName

getConnection

getConnection

getLogWriter

setLogWriter

getLoginTimeout

setLoginTimeout

unwrap

isWrapperFor

getXAConnection

getXAConnection

getParentLogger

getUrlParser

initialize

setURL

getURL