ConnectionPool Class

The ConnectionPool class represents a pool of connections for a specific database.

createConnection()

Creates a pooled connection.

Connection* createConnection(
   const string &userName,
   const string &password)=0;

Connection* createConnection(
   const UString &username,
   const UString &password)=0;

userName

password

createProxyConnection()

Creates a proxy connection from the connection pool.

Connection* createProxyConnection(
   const string &name,
   Connection::ProxyType 
      proxyType=Connection::PROXY_DEFAULT)=0;

Connection* createProxyConnection(
   const UString &name,
   Connection::ProxyType 
      proxyType=Connection::PROXY_DEFAULT)=0;

Connection* createProxyConnection(
   const string &name,
   string roles[],
   int numRoles,
   Connection::ProxyType 
      proxyType=Connection::PROXY_DEFAULT)=0;

Connection* createProxyConnection(
   const UString &name,
   string roles[],
   unsigned int numRoles,
   Connection::ProxyType 
      proxyType=Connection::PROXY_DEFAULT)=0;

name

roles

numRoles

proxyType

getBusyConnections()

Returns the number of busy connections in the connection pool.

Syntax

unsigned int getBusyConnections() const=0;

getIncrConnections()

Returns the number of incremental connections in the connection pool.

Syntax

unsigned int getIncrConnections() const=0;

getMaxConnections()

Returns the maximum number of connections in the connection pool.

Syntax

unsigned int getMaxConnections() const=0;

getMinConnections()

Returns the minimum number of connections in the connection pool.

Syntax

unsigned int getMinConnections() const=0;

getOpenConnections()

Returns the number of open connections in the connection pool.

Syntax

unsigned int getOpenConnections() const=0;

getPoolName()

Returns the name of the connection pool.

Syntax

string getPoolName() const=0;

getStmtCacheSize()

Retrieves the size of the statement cache.

Syntax

unsigned int getStmtCacheSize() const=0;

getTimeOut()

Returns the time out period of a connection in the connection pool.

Syntax

unsigned int getTimeOut() const=0;

setErrorOnBusy()

Specifies that a SQLException is to be generated when all connections in the connection pool are busy and no further connections can be opened.

Syntax

void setErrorOnBusy()=0;

setPoolSize()

Sets the minimum, maximum, and incremental number of pooled connections for the connection pool.

Syntax

void setPoolSize(
   unsigned int minConn = 0,
   unsigned int maxConn = 1,
   unsigned int incrConn = 1)=0;

minConn

maxConn

incrConn

setStmtCacheSize()

Enables or disables statement caching. A nonzero value will enable statement caching, with a cache of specified size. A zero value will disable caching.

Syntax

void setStmtCacheSize(
   unsigned int cacheSize)=0;

cacheSize

setTimeOut()

Sets the time out period for a connection in the connection pool. OCCI will terminate any connections related to this connection pool that have been idle for longer than the time out period specified.

Syntax

void setTimeOut(
   unsigned int connTimeOut = 0)=0;

connTimeOut

terminateConnection()

Terminates the pooled connection or proxy connection.

Syntax

void terminateConnection(
   Connection *connection)=0;

connection