DatasourceOptions (SequoiaDB Java Driver 3.0 API)

java.lang.Object
- com.sequoiadb.datasource.DatasourceOptions

所有已实现的接口:

Cloneable
```
public class DatasourceOptions
extends Object
implements Cloneable
```
Options of data source

从以下版本开始:

2.2

构造器概要

构造器
构造器和说明

DatasourceOptions()

构造器
构造器和说明
`DatasourceOptions()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Object`	`clone()` Clone the current options.
`int`	`getCheckInterval()` Get the interval for checking the idle connections periodically.
`ConnectStrategy`	`getConnectStrategy()` Get the current strategy of creating connections.
`int`	`getDeltaIncCount()` Get the number of connections to create once running out the connection pool.
`int`	`getKeepAliveTimeout()` Get the setup time for abandoning a connection which has not been used for long time.
`int`	`getMaxCount()` Get the capacity of the pool.
`int`	`getMaxIdleCount()` Get the max number of idle connection.
`List<String>`	`getPreferedInstance()` Get the preferred instance.
`String`	`getPreferedInstanceMode()` Get the preferred instance node.
`int`	`getSessionTimeout()` The Session timeout value.
`int`	`getSyncCoordInterval()` Get the interval for updating coord's addresses from catalog periodically.
`boolean`	`getValidateConnection()` Get whether to validate a connection which is got from the pool or not.
`void`	`setCheckInterval(int checkInterval)` Set the checking interval in milliseconds.
`void`	`setConnectStrategy(ConnectStrategy strategy)` Set connection strategy.
`void`	`setDeltaIncCount(int deltaIncCount)` Set the number of new connections to create once running out the connection pool.
`void`	`setKeepAliveTimeout(int keepAliveTimeout)` Set the time in milliseconds for abandoning a connection which keep alive time is up.
`void`	`setMaxCount(int maxCount)` Set the capacity of the connection pool.
`void`	`setMaxIdleCount(int maxIdleCount)` Set the max number of the idle connection left in connection pool after periodically cleaning.
`void`	`setPreferedInstance(List<String> preferedInstance)` Set Preferred instance for read request in the session..
`void`	`setPreferedInstanceMode(String mode)` Set the mode to choose query instance when multiple preferred instances are found in the session.
`void`	`setSessionTimeout(int timeout)` Set the timeout (in ms) for operations in the session. -1 means no timeout for operations.
`void`	`setSyncCoordInterval(int syncCoordInterval)` Set the interval for updating coord's addresses from catalog in milliseconds.
`void`	`setValidateConnection(boolean validateConnection)` When a idle connection is got out of pool, we need to validate whether it can be used or not.

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

- 构造器详细资料
  - DatasourceOptions
```
public DatasourceOptions()
```
- 方法详细资料
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Clone the current options.
    
    覆盖:
    
    clone 在类中 Object
    
    抛出:
    
    CloneNotSupportedException
    
    从以下版本开始:
    
    2.2
  - getCheckInterval
```
public int getCheckInterval()
```
    Get the interval for checking the idle connections periodically.
    
    返回:
    
    the interval
    
    从以下版本开始:
    
    2.2
  - getConnectStrategy
```
public ConnectStrategy getConnectStrategy()
```
    Get the current strategy of creating connections.
    
    返回:
    
    the strategy
    
    从以下版本开始:
    
    2.2
  - getDeltaIncCount
```
public int getDeltaIncCount()
```
    Get the number of connections to create once running out the connection pool.
    
    返回:
    
    the number of connections created each time
  - getKeepAliveTimeout
```
public int getKeepAliveTimeout()
```
    Get the setup time for abandoning a connection which has not been used for long time.
    
    返回:
    
    the keep alive timeout time
    
    从以下版本开始:
    
    2.2
  - getMaxCount
```
public int getMaxCount()
```
    Get the capacity of the pool.
    
    返回:
    
    The capacity of the pool.
  - getMaxIdleCount
```
public int getMaxIdleCount()
```
    Get the max number of idle connection.
    
    返回:
    
    The max number of idle connection after checking.
  - getPreferedInstance
```
public List<String> getPreferedInstance()
```
    Get the preferred instance.
    
    返回:
    
    The preferred instance or null for no any setting.
  - getPreferedInstanceMode
```
public String getPreferedInstanceMode()
```
    Get the preferred instance node.
    
    返回:
    
    The preferred instance node.
  - getSessionTimeout
```
public int getSessionTimeout()
```
    The Session timeout value.
    
    返回:
    
    Session timeout value.
  - getSyncCoordInterval
```
public int getSyncCoordInterval()
```
    Get the interval for updating coord's addresses from catalog periodically.
    
    返回:
    
    the interval
    
    从以下版本开始:
    
    2.2
  - getValidateConnection
```
public boolean getValidateConnection()
```
    Get whether to validate a connection which is got from the pool or not.
    
    返回:
    
    true or false
    
    从以下版本开始:
    
    2.2
  - setCheckInterval
```
public void setCheckInterval(int checkInterval)
```
    Set the checking interval in milliseconds. Every interval, the pool cleans all the idle connection which keep alive time is up, and keeps the number of idle connection not more than "maxIdleCount". When "keepAliveTimeout" is not be 0, "checkInterval" should be less than it. It's better to set "keepAliveTimeout" greater than "checkInterval" triple over.
    
    参数:
    
    checkInterval - Default to be 1 * 60 * 1000ms.
    
    从以下版本开始:
    
    2.2
  - setConnectStrategy
```
public void setConnectStrategy(ConnectStrategy strategy)
```
    Set connection strategy. When choosing ConnectStrategy.LOCAL, if there have no local coord address, use other address instead.
    
    参数:
    
    strategy - Should one of the follow: ConnectStrategy.SERIAL, ConnectStrategy.RANDOM, ConnectStrategy.LOCAL, ConnectStrategy.BALANCE
    
    从以下版本开始:
    
    2.2
  - setDeltaIncCount
```
public void setDeltaIncCount(int deltaIncCount)
```
    Set the number of new connections to create once running out the connection pool.
    
    参数:
    
    deltaIncCount - Default to be 10.
  - setKeepAliveTimeout
```
public void setKeepAliveTimeout(int keepAliveTimeout)
```
    Set the time in milliseconds for abandoning a connection which keep alive time is up. If a connection has not be used(send and receive) for a long time(longer than "keepAliveTimeout"), the pool will not let it come back. The pool will also clean this kind of idle connections in the pool periodically. When "keepAliveTimeout" is not set to 0, it's better to set it greater than "checkInterval" triple over. Besides, unless you know what you need, never enable this option.
    
    参数:
    
    keepAliveTimeout - Default to be 0ms, means not care about how long does a connection have not be used(send and receive).
    
    从以下版本开始:
    
    2.2
  - setMaxCount
```
public void setMaxCount(int maxCount)
```
    Set the capacity of the connection pool. When maxCount is set to 0, the connection pool will be disabled.
    
    参数:
    
    maxCount - Default to be 500.
    
    从以下版本开始:
    
    2.2
  - setMaxIdleCount
```
public void setMaxIdleCount(int maxIdleCount)
```
    Set the max number of the idle connection left in connection pool after periodically cleaning.
    
    参数:
    
    maxIdleCount - Default to be 10.
    
    从以下版本开始:
    
    2.2
  - setPreferedInstance
```
public void setPreferedInstance(List<String> preferedInstance)
```
    Set Preferred instance for read request in the session.. When user does not set any preferred instance, use the setting in the coord's setting file. Note: When specifying preferred instance, Datasource will set the session attribute only when it creating a connection. That means when user get a connection out from the Datasource, if user reset the session attribute of the connection, Datasource will keep the latest changes of the setting.
    参数:
    preferedInstance - Could be single value in "M", "m", "S", "s", "A", "a", "1"-"255", or multiple values of them.
    
    "M", "m": read and write instance( master instance ). If multiple numeric instances are given with "M", matched master instance will be chosen in higher priority. If multiple numeric instances are given with "M" or "m", master instance will be chosen if no numeric instance is matched.
    
    "S", "s": read only instance( slave instance ). If multiple numeric instances are given with "S", matched slave instances will be chosen in higher priority. If multiple numeric instances are given with "S" or "s", slave instance will be chosen if no numeric instance is matched.
    
    "A", "a": any instance.
    
    "1"-"255": the instance with specified instance ID.
    
    If multiple alphabet instances are given, only first one will be used.
    
    If matched instance is not found, will choose instance by random.
  - setPreferedInstanceMode
```
public void setPreferedInstanceMode(String mode)
```
    Set the mode to choose query instance when multiple preferred instances are found in the session.
    参数:
    mode - can be one of the follow, default to be "random".
    
    "random": choose the instance from matched instances by random.
    
    "ordered": choose the instance from matched instances by the order of "PreferedInstance".
  - setSessionTimeout
```
public void setSessionTimeout(int timeout)
```
    Set the timeout (in ms) for operations in the session. -1 means no timeout for operations. Default te be -1.
    
    参数:
    
    timeout - The timeout (in ms) for operations in the session.
  - setSyncCoordInterval
```
public void setSyncCoordInterval(int syncCoordInterval)
```
    Set the interval for updating coord's addresses from catalog in milliseconds. The updated coord addresses will cover the addresses in the pool. When "syncCoordInterval" is 0, the pool will stop updating coord's addresses from catalog. when "syncCoordInterval" is less than 60,000 milliseconds, use 60,000 milliseconds instead.
    
    参数:
    
    syncCoordInterval - Default to be 1 * 60 * 1000ms.
    
    从以下版本开始:
    
    2.2
  - setValidateConnection
```
public void setValidateConnection(boolean validateConnection)
```
    When a idle connection is got out of pool, we need to validate whether it can be used or not.
    
    参数:
    
    validateConnection - Default to be false.
    
    从以下版本开始:
    
    2.2

类 DatasourceOptions

构造器概要

方法概要

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

构造器详细资料

DatasourceOptions

方法详细资料

clone

getCheckInterval

getConnectStrategy

getDeltaIncCount

getKeepAliveTimeout

getMaxCount

getMaxIdleCount

getPreferedInstance

getPreferedInstanceMode

getSessionTimeout

getSyncCoordInterval

getValidateConnection

setCheckInterval

setConnectStrategy

setDeltaIncCount

setKeepAliveTimeout

setMaxCount

setMaxIdleCount

setPreferedInstance

setPreferedInstanceMode

setSessionTimeout

setSyncCoordInterval

setValidateConnection