com.sequoiadb.datasource

类 SequoiadbDatasource

java.lang.Object

com.sequoiadb.datasource.SequoiadbDatasource

public class SequoiadbDatasource
extends Object

The implements for SequoiaDB data source

从以下版本开始:

v1.12.6 & v2.2

构造器概要

构造器

构造器和说明
SequoiadbDatasource(List<String> urls, String username, String password, ConfigOptions nwOpt, DatasourceOptions dsOpt) When offer several addresses for connection pool to use, if some of them are not available(invalid address, network error, coord shutdown, catalog replica group is not available), we will put these addresses into a queue, and check them periodically.
SequoiadbDatasource(String url, String username, String password, DatasourceOptions dsOpt)

方法概要

限定符和类型	方法和说明
void	addCoord(String url) Add coord address.
void	close() Clean all resources of current connection pool.
void	disableDatasource() Disable the data source.
void	enableDatasource() Enable data source.
int	getAbnormalAddrNum() Get the current abnormal address amount.
Sequoiadb	getConnection() Get a connection from current connection pool.
Sequoiadb	getConnection(long timeout) Get a connection from current connection pool.
DatasourceOptions	getDatasourceOptions() Get a copy of the connection pool options.
int	getIdleConnNum() Get the current idle connection amount.
int	getLocalAddrNum() Get the amount of local coord node address.
int	getNormalAddrNum() Get the current normal address amount.
int	getUsedConnNum() Get the current used connection amount.
void	releaseConnection(Sequoiadb sdb) Put the connection back to the connection pool.
void	removeCoord(String url) Remove coord address.
void	updateDatasourceOptions(DatasourceOptions dsOpt) Update connection pool options.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

SequoiadbDatasource

public SequoiadbDatasource(List<String> urls,
                           String username,
                           String password,
                           ConfigOptions nwOpt,
                           DatasourceOptions dsOpt)
                    throws BaseException

When offer several addresses for connection pool to use, if some of them are not available(invalid address, network error, coord shutdown, catalog replica group is not available), we will put these addresses into a queue, and check them periodically. If some of them is valid again, get them back for use. When connection pool get a unavailable address to connect, the default timeout is 100ms, and default retry time is 0. Parameter nwOpt can can change both of the default value.

参数:

urls - the addresses of coord nodes, can't be null or empty, e.g."ubuntu1:11810","ubuntu2:11810",...

username - the user name for logging sequoiadb

password - the password for logging sequoiadb

nwOpt - the options for connection

dsOpt - the options for connection pool

抛出:

BaseException - If error happens.

另请参阅:

ConfigOptions, DatasourceOptions

SequoiadbDatasource

public SequoiadbDatasource(String url,
                           String username,
                           String password,
                           DatasourceOptions dsOpt)
                    throws BaseException

参数:

url - the address of coord, can't be empty or null, e.g."ubuntu1:11810"

username - the user name for logging sequoiadb

password - the password for logging sequoiadb

dsOpt - the options for connection pool

抛出:

BaseException - If error happens.

方法详细资料

addCoord

public void addCoord(String url)
              throws BaseException

Add coord address.

参数:

url - The address in format "192.168.20.168:11810"

抛出:

BaseException - If error happens.

close

public void close()

Clean all resources of current connection pool.

disableDatasource

public void disableDatasource()

Disable the data source. After disable data source, the pool will not manage the connections again. When a getting request comes, the pool build and return a connection; When a connection is put back, the pool disconnect it directly.

抛出:

BaseException - If error happens.

从以下版本开始:

2.2

enableDatasource

public void enableDatasource()

Enable data source. When maxCount is 0, set it to be the default value(500).

抛出:

BaseException - If error happens.

从以下版本开始:

2.2

getAbnormalAddrNum

public int getAbnormalAddrNum()

Get the current abnormal address amount.

getConnection

public Sequoiadb getConnection()
                        throws BaseException,
                               InterruptedException

Get a connection from current connection pool. When the pool runs out, a request will wait up to 5 seconds. When time is up, if the pool still has no idle connection, it throws BaseException with the type of "SDB_DRIVER_DS_RUNOUT".

返回:

Sequoiadb the connection for using

抛出:

BaseException - If error happens.

InterruptedException - Actually, nothing happen. Throw this for compatibility reason.

getConnection

public Sequoiadb getConnection(long timeout)
                        throws BaseException,
                               InterruptedException

Get a connection from current connection pool.

参数:

timeout - the time for waiting for connection in millisecond. 0 for waiting until a connection is available.

返回:

Sequoiadb the connection for using

抛出:

BaseException - when connection pool run out, throws BaseException with the type of "SDB_DRIVER_DS_RUNOUT"

InterruptedException - Actually, nothing happen. Throw this for compatibility reason.

从以下版本开始:

2.2

getDatasourceOptions

public DatasourceOptions getDatasourceOptions()
                                       throws BaseException

Get a copy of the connection pool options.

返回:

a copy of the connection pool options

抛出:

BaseException - If error happens.

从以下版本开始:

2.2

getIdleConnNum

public int getIdleConnNum()

Get the current idle connection amount.

getLocalAddrNum

public int getLocalAddrNum()

Get the amount of local coord node address. This method works only when the pool is enabled and the connect strategy is ConnectStrategy.LOCAL, otherwise return 0.

返回:

the amount of local coord node address

抛出:

BaseException - If error happens.

从以下版本开始:

2.2

getNormalAddrNum

public int getNormalAddrNum()

Get the current normal address amount.

getUsedConnNum

public int getUsedConnNum()

Get the current used connection amount.

releaseConnection

public void releaseConnection(Sequoiadb sdb)
                       throws BaseException

Put the connection back to the connection pool. When the data source is enable, we can't double release one connection, and we can't offer a connection which is not belong to the pool.

参数:

sdb - the connection to come back, can't be null

抛出:

BaseException - If error happens.

从以下版本开始:

2.2

removeCoord

public void removeCoord(String url)
                 throws BaseException

Remove coord address.

抛出:

BaseException

从以下版本开始:

2.2

updateDatasourceOptions

public void updateDatasourceOptions(DatasourceOptions dsOpt)
                             throws BaseException

Update connection pool options.

抛出:

BaseException - If error happens.

从以下版本开始:

2.2