- 3.45.0 (latest)
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.1
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.1
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.27.1
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.2
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.1
- 3.14.1
- 3.13.0
- 3.12.1
- 3.11.1
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.1.1
- 2.0.0
- 1.19.3
- 1.18.0
- 1.17.1
- 1.16.0
- 1.15.1
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
TransactionPingingPool(
size=10, default_timeout=10, ping_interval=3000, labels=None
)Concrete session pool implementation:
In addition to the features of PingingPool, this class
creates and begins a transaction for each of its sessions at startup.
When a session is returned to the pool, if its transaction has been
committed or rolled back, the pool creates a new transaction for the
session and pushes the transaction onto a separate queue of "transactions
to begin." The application is responsible for flushing this queue
as appropriate via the pool's begin_pending_transactions method.
Parameters | |
|---|---|
| Name | Description |
size |
int
fixed pool size |
default_timeout |
int
default timeout, in seconds, to wait for a returned session. |
ping_interval |
int
interval at which to ping sessions. |
labels |
dict (str -> str) or None
(Optional) user-assigned labels for sessions created by the pool. |
Properties
labels
User-assigned labels for sesions created by the pool.
| Returns | |
|---|---|
| Type | Description |
dict (str -> str) | labels assigned by the user |
Methods
begin_pending_transactions
begin_pending_transactions()Begin all transactions for sessions added to the pool.
bind
bind(database)Associate the pool with a database.
| Parameter | |
|---|---|
| Name | Description |
database |
Database
database used by the pool: used to create sessions when needed. |
clear
clear()Delete all sessions in the pool.
get
get(timeout=None)Check a session out from the pool.
| Parameter | |
|---|---|
| Name | Description |
timeout |
int
seconds to block waiting for an available session |
| Exceptions | |
|---|---|
| Type | Description |
`six.moves.queue.Empty | if the queue is empty. |
| Returns | |
|---|---|
| Type | Description |
Session | an existing session from the pool, or a newly-created session. |
ping
ping()Refresh maybe-expired sessions in the pool.
This method is designed to be called from a background thread, or during the "idle" phase of an event loop.
put
put(session)Return a session to the pool.
Never blocks: if the pool is full, raises.
| Parameter | |
|---|---|
| Name | Description |
session |
Session
the session being returned. |
| Exceptions | |
|---|---|
| Type | Description |
`six.moves.queue.Full | if the queue is full. |
session
session(**kwargs)Check out a session from the pool.
| Returns | |
|---|---|
| Type | Description |
SessionCheckout | a checkout instance, to be used as a context manager for accessing the session and returning it to the pool. |