summaryrefslogtreecommitdiff
path: root/doc/src/module.rst
diff options
context:
space:
mode:
authorDaniele Varrazzo <daniele.varrazzo@gmail.com>2011-11-17 01:51:25 +0000
committerDaniele Varrazzo <daniele.varrazzo@gmail.com>2011-11-17 01:51:25 +0000
commitd2b67364fd2b0b192342281d24a7e3d0a4909980 (patch)
tree1480f749b88f9770cd9356aa8c53f405e1c0f543 /doc/src/module.rst
parent4254fb85660c66f261ded926145ac6d910ea60e2 (diff)
downloadpsycopg2-d2b67364fd2b0b192342281d24a7e3d0a4909980.tar.gz
connect() supports generic keyword arguments passed to the dsn
Diffstat (limited to 'doc/src/module.rst')
-rw-r--r--doc/src/module.rst20
1 files changed, 15 insertions, 5 deletions
diff --git a/doc/src/module.rst b/doc/src/module.rst
index fb70962..29f4b63 100644
--- a/doc/src/module.rst
+++ b/doc/src/module.rst
@@ -20,7 +20,7 @@ The module interface respects the standard defined in the |DBAPI|_.
Create a new database session and return a new `connection` object.
- You can specify the connection parameters either as a string::
+ The connection parameters can be specified either as a string::
conn = psycopg2.connect("dbname=test user=postgres password=secret")
@@ -28,17 +28,23 @@ The module interface respects the standard defined in the |DBAPI|_.
conn = psycopg2.connect(database="test", user="postgres", password="secret")
- The full list of available parameters is:
-
+ The basic connection parameters are:
+
- `!dbname` -- the database name (only in dsn string)
- `!database` -- the database name (only as keyword argument)
- `!user` -- user name used to authenticate
- `!password` -- password used to authenticate
- `!host` -- database host address (defaults to UNIX socket if not provided)
- `!port` -- connection port number (defaults to 5432 if not provided)
- - `!sslmode` -- `SSL TCP/IP negotiation`__ mode
- .. __: http://www.postgresql.org/docs/9.0/static/libpq-ssl.html#LIBPQ-SSL-SSLMODE-STATEMENTS
+ Any other connection parameter supported by the client library/server can
+ be passed either in the connection string or as keyword. See the
+ PostgreSQL documentation for a complete `list of supported parameters`__.
+ Also note that the same parameters can be passed to the client library
+ using `environment variables`__.
+
+ .. __: http://www.postgresql.org/docs/9.1/static/libpq-connect.html#LIBPQ-PQCONNECTDBPARAMS
+ .. __: http://www.postgresql.org/docs/9.1/static/libpq-envars.html
Using the *connection_factory* parameter a different class or
connections factory can be specified. It should be a callable object
@@ -48,6 +54,10 @@ The module interface respects the standard defined in the |DBAPI|_.
Using *async*\=1 an asynchronous connection will be created: see
:ref:`async-support` to know about advantages and limitations.
+ .. versionchanged:: 2.4.3
+ any keyword argument is passed to the connection. Previously only the
+ basic parameters (plus `!sslmode`) were supported as keywords.
+
.. extension::
The parameters *connection_factory* and *async* are Psycopg extensions