REDROOM

Navigation

Breadcrumbs

Create

Edit File Size: 1.82 KB

//opt/alt/python37/share/doc/alt-python37-psycopg2/doc/src/pool.rst

Text Base64

`psycopg2.pool` -- Connections pooling
======================================

.. sectionauthor:: Daniele Varrazzo <daniele.varrazzo@gmail.com>

.. index::
    pair: Connection; Pooling

.. module:: psycopg2.pool

Creating new PostgreSQL connections can be an expensive operation.  This
module offers a few pure Python classes implementing simple connection pooling
directly in the client application.

.. class:: AbstractConnectionPool(minconn, maxconn, \*args, \*\*kwargs)

Base class implementing generic key-based pooling code.

New *minconn* connections are created automatically. The pool will support
    a maximum of about *maxconn* connections.  *\*args* and *\*\*kwargs* are
    passed to the `~psycopg2.connect()` function.

The following methods are expected to be implemented by subclasses:

.. method:: getconn(key=None)

Get a free connection from the pool.

The *key* parameter is optional: if used, the connection will be
        associated to the key and calling `!getconn()` with the same key again
        will return the same connection.

.. method:: putconn(conn, key=None, close=False)

Put away a connection.

If *close* is `!True`, discard the connection from the pool.
        *key* should be used consistently with `getconn()`.

.. method:: closeall

Close all the connections handled by the pool.

Note that all the connections are closed, including ones
        eventually in use by the application.

The following classes are `AbstractConnectionPool` subclasses ready to
be used.

.. autoclass:: SimpleConnectionPool

.. note:: This pool class is useful only for single-threaded applications.

.. index:: Multithread; Connection pooling

.. autoclass:: ThreadedConnectionPool

.. note:: This pool class can be safely used in multi-threaded applications.

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
tools DIR	-	drwxr-xr-x	2023-05-06 02:18:13	Edit Download recursive recursive
_static DIR	-	drwxr-xr-x	2023-05-06 02:18:13	Edit Download recursive recursive
advanced.rst	21.90 KB	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
conf.py	8.27 KB	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
connection.rst	33.26 KB	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
cursor.rst	23.05 KB	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
errorcodes.rst	2.46 KB	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
errors.rst	2.90 KB	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
extensions.rst	32.81 KB	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
extras.rst	35.61 KB	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
faq.rst	14.59 KB	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
index.rst	1.83 KB	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
install.rst	10.31 KB	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
license.rst	76 B	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
Makefile	3.31 KB	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
module.rst	13.04 KB	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
news.rst	108 B	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
pool.rst	1.82 KB	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
sql.rst	3.02 KB	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
tz.rst	542 B	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive
usage.rst	40.68 KB	lrw-r--r--	2019-10-20 00:45:30	Edit Download recursive recursive

Directory Contents