API

exception dbpool.PoolError[source]

Pool Error

exception dbpool.NoAvailableConnectionError[source]

no available conneciton

exception dbpool.CreateConnectionError[source]

When create new conneciton

exception dbpool.TestConnectionError[source]

test connection error

class dbpool.PoolOption[source]
Parameters:
  • min_idle (int) – Hold min idle connection count.
  • max_idle (int) – Hold max idle connection count.
  • max_age_in_sec (float) – When a connection expired, reconnect. Default: 300.0 seconds
  • check_idle_interval (float) – Check idle thread run interval time. Default: 60.0 seconds
class dbpool.PooledConnection(*args, **kwargs)[source]

Inherit from mysql.connector.MySQLConnection.

Client should not create PooledConnection.

Just call dbpool.ConnectionPool.borrow_connection().

close() → None[source]

Return this connection to the pool.

class dbpool.ConnectionPool(option: dbpool.impl.PoolOption, **kwargs)[source]
close()[source]

Close the ConnectionPool. Free idle connections.

borrow_connection() → dbpool.impl.PooledConnection[source]

Borrow one connection from pool.

Returns:

The available connection.
Return type:

PooledConnection
Raises: