DatasourceOptions (SequoiaDB Java Driver 3.4 API)

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

All Implemented Interfaces:: Cloneable

public class DatasourceOptions
extends Object
implements Cloneable

Options of data source

Since:: 2.2

Constructor Summary

Constructors
Constructor and Description

DatasourceOptions()

Constructors
Constructor and Description
`DatasourceOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()` Clone the current options.
`int`	`getCacheLimit()` Get the cache size limit of the session.
`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 maximum number of idle connections.
`int`	`getMinIdleCount()` Get the minimum number of idle connections.
`int`	`getNetworkBlockTimeout()` Get the network block timeout
`List<String>`	`getPreferredInstance()` Get the preferred instance.
`String`	`getPreferredInstanceMode()` 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`	`setCacheLimit(int limitBytes)` Set the cache size limit of the session.
`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 maximum number of idle connections.
`void`	`setMinIdleCount(int minIdleCount)` Set the minimum number of idle connections.
`void`	`setNetworkBlockTimeout(int networkBlockTimeout)` Set the network block timeout, which is used to set the send and receive timeout of the connections inside the connection pool.
`void`	`setPreferredInstance(List<String> preferredInstance)` Set preferred instance for read request in the session.
`void`	`setPreferredInstanceMode(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.
`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.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DatasourceOptions
```
public DatasourceOptions()
```
- Method Detail
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Clone the current options.
    
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
    
    Since:
    
    2.2
  - getCacheLimit
```
public int getCacheLimit()
```
    Get the cache size limit of the session.
    
    Returns:
    
    The cache size limit of the session.
  - getCheckInterval
```
public int getCheckInterval()
```
    Get the interval for checking the idle connections periodically.
    
    Returns:
    
    the interval
    
    Since:
    
    2.2
  - getConnectStrategy
```
public ConnectStrategy getConnectStrategy()
```
    Get the current strategy of creating connections.
    
    Returns:
    
    the strategy
    
    Since:
    
    2.2
  - getDeltaIncCount
```
public int getDeltaIncCount()
```
    Get the number of connections to create once running out the connection pool.
    
    Returns:
    
    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.
    
    Returns:
    
    the keep alive timeout time
    
    Since:
    
    2.2
  - getMaxCount
```
public int getMaxCount()
```
    Get the capacity of the pool.
    
    Returns:
    
    The capacity of the pool.
  - getMaxIdleCount
```
public int getMaxIdleCount()
```
    Get the maximum number of idle connections.
    
    Returns:
    
    The maximum number of idle connections.
  - getMinIdleCount
```
public int getMinIdleCount()
```
    Get the minimum number of idle connections.
    
    Returns:
    
    The minimum number of idle connections.
  - getNetworkBlockTimeout
```
public int getNetworkBlockTimeout()
```
    Get the network block timeout
    
    Returns:
    
    The network block timeout
  - getPreferredInstance
```
public List<String> getPreferredInstance()
```
    Get the preferred instance.
    
    Returns:
    
    The preferred instance or null for no any setting.
  - getPreferredInstanceMode
```
public String getPreferredInstanceMode()
```
    Get the preferred instance node.
    
    Returns:
    
    The preferred instance node.
  - getSessionTimeout
```
public int getSessionTimeout()
```
    The Session timeout value.
    
    Returns:
    
    Session timeout value.
  - getSyncCoordInterval
```
public int getSyncCoordInterval()
```
    Get the interval for updating coord's addresses from catalog periodically.
    
    Returns:
    
    the interval
    
    Since:
    
    2.2
  - getValidateConnection
```
public boolean getValidateConnection()
```
    Get whether to validate a connection which is got from the pool or not.
    
    Returns:
    
    true or false
    
    Since:
    
    2.2
  - setCacheLimit
```
public void setCacheLimit(int limitBytes)
```
    Set the cache size limit of the session. 0 means not set the limit for the session cache size. Default to be 131072 bytes(128 KB). When the cache size of the session reaches the limit, the session will be destroyed after the connection release to pool.
    
    Parameters:
    
    limitBytes - The cache size limit of the session in bytes.
  - 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.
    
    Parameters:
    
    checkInterval - CheckInterval should be more than 0, default to be 1 * 60 * 1000ms.
    
    Throws:
    
    BaseException - If error happens.
    
    Since:
    
    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.
    
    Parameters:
    
    strategy - Should one of the follow: ConnectStrategy.SERIAL, ConnectStrategy.RANDOM, ConnectStrategy.LOCAL, ConnectStrategy.BALANCE
    
    Since:
    
    2.2
  - setDeltaIncCount
```
public void setDeltaIncCount(int deltaIncCount)
```
    Set the number of new connections to create once running out the connection pool.
    
    Parameters:
    
    deltaIncCount - DeltaIncCount should be more than 0, default to be 10.
    
    Throws:
    
    BaseException - If error happens.
  - 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.
    
    Parameters:
    
    keepAliveTimeout - KeepAliveTimeout can't be less than 0, default to be 0ms, means not care about how long does a connection have not be used(send and receive).
    
    Throws:
    
    BaseException - If error happens.
    
    Since:
    
    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.
    
    Parameters:
    
    maxCount - MaxCount should be can't be less than 0, default to be 500.
    
    Throws:
    
    BaseException - If error happens.
    
    Since:
    
    2.2
  - setMaxIdleCount
```
public void setMaxIdleCount(int maxIdleCount)
```
    Set the maximum number of idle connections. When the number of idle connections in the pool is more than 'maxIdleCount', the pool will destroy some connections.
    
    Parameters:
    
    maxIdleCount - MaxIdleCount can't be less than 0, default to be 10.
    
    Throws:
    
    BaseException - If error happens.
    
    Since:
    
    2.2
  - setMinIdleCount
```
public void setMinIdleCount(int minIdleCount)
```
    Set the minimum number of idle connections. When the number of idle connections in the pool is less than the average of 'minIdleCount' and 'maxIdleCount', the pool will create some connections.
    
    Parameters:
    
    minIdleCount - MinIdleCount can't be less than 0, default to be 0.
    
    Throws:
    
    BaseException - If error happens.
    
    Since:
    
    v2.8.10
  - setNetworkBlockTimeout
```
public void setNetworkBlockTimeout(int networkBlockTimeout)
```
    Set the network block timeout, which is used to set the send and receive timeout of the connections inside the connection pool. After a connection get out from the connection pool, its send and receive timeout will be restored to the original state.
    
    Parameters:
    
    networkBlockTimeout - NetworkBlockTimeout can't be less than 0, default to be 6000ms, 0ms and means no timeout.
    
    Throws:
    
    BaseException - If error happens.
  - setPreferredInstance
```
public void setPreferredInstance(List<String> preferredInstance)
```
    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.
    Parameters:
    preferredInstance - 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.
    Throws:
    
    BaseException - If error happens.
  - setPreferredInstanceMode
```
public void setPreferredInstanceMode(String mode)
```
    Set the mode to choose query instance when multiple preferred instances are found in the session.
    Parameters:
    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".
    Throws:
    
    BaseException - If error happens.
  - 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.
    
    Parameters:
    
    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.
    
    Parameters:
    
    syncCoordInterval - SyncCoordInterval can't be less than 0, default to be 0ms.
    
    Throws:
    
    BaseException - If error happens.
    
    Since:
    
    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.
    
    Parameters:
    
    validateConnection - Default to be false.
    
    Since:
    
    2.2
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DatasourceOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DatasourceOptions

Method Detail

clone

getCacheLimit

getCheckInterval

getConnectStrategy

getDeltaIncCount

getKeepAliveTimeout

getMaxCount

getMaxIdleCount

getMinIdleCount

getNetworkBlockTimeout

getPreferredInstance

getPreferredInstanceMode

getSessionTimeout

getSyncCoordInterval

getValidateConnection

setCacheLimit

setCheckInterval

setConnectStrategy

setDeltaIncCount

setKeepAliveTimeout

setMaxCount

setMaxIdleCount

setMinIdleCount

setNetworkBlockTimeout

setPreferredInstance

setPreferredInstanceMode

setSessionTimeout

setSyncCoordInterval

setValidateConnection

toString