diff options
| author | Daniele Varrazzo <daniele.varrazzo@gmail.com> | 2010-04-08 13:22:55 +0100 |
|---|---|---|
| committer | Daniele Varrazzo <daniele.varrazzo@gmail.com> | 2010-04-08 13:25:17 +0100 |
| commit | 6aaa50703ec417c35456efa80c4db06ca1ebb46c (patch) | |
| tree | 1ebd726804f2b3896ebc0d53091fd7282e4a25a5 /doc/src/module.rst | |
| parent | d197346ce3e73f7e19ec2b54b4160c1829a76355 (diff) | |
| download | psycopg2-6aaa50703ec417c35456efa80c4db06ca1ebb46c.tar.gz | |
Added documentation for the new asynchronous support.
Diffstat (limited to 'doc/src/module.rst')
| -rw-r--r-- | doc/src/module.rst | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/src/module.rst b/doc/src/module.rst index df06703..db7586e 100644 --- a/doc/src/module.rst +++ b/doc/src/module.rst @@ -16,7 +16,7 @@ The module interface respects the standard defined in the |DBAPI|_. single: Port; Connection single: DSN (Database Source Name) -.. function:: connect(dsn or params[, connection_factory]) +.. function:: connect(dsn or params [, connection_factory] [, async=0]) Create a new database session and return a new `connection` object. @@ -40,15 +40,18 @@ The module interface respects the standard defined in the |DBAPI|_. .. __: http://www.postgresql.org/docs/8.4/static/libpq-ssl.html#LIBPQ-SSL-SSLMODE-STATEMENTS - Using the `connection_factory` parameter a different class or + Using the *connection_factory* parameter a different class or connections factory can be specified. It should be a callable object - taking a `dsn` argument. See :ref:`subclassing-connection` for + taking a *dsn* argument. See :ref:`subclassing-connection` for details. + Using *async*\=1 an asynchronous connection will be created: see + :ref:`async-support` to know about advantages and limitations. + .. extension:: - The `connection_factory` parameter is a Psycopg extension to the - |DBAPI|. + The parameters *connection_factory* and *async* are Psycopg extensions + to the |DBAPI|. .. data:: apilevel |