Skip to content

Commit 48a055e

Browse files
author
James William Pye
committed
Minor touch-ups and add a better introductory paragraph.
1 parent 65e25ce commit 48a055e

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

postgresql/documentation/clientparameters.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
Client Parameters
77
*****************
88
9+
There are various sources of parameters used by PostgreSQL client applications.
10+
The `postgresql.clientparameters` module provides a means for collecting and
11+
managing those parameters.
12+
913
Connection creation interfaces in `postgresql.driver` are purposefully simple.
1014
All parameters taken by those interfaces are keywords, and are taken
1115
literally; if a parameter is not given, it will effectively be `None`.
@@ -201,7 +205,7 @@
201205
202206
The following is a list of environment variables that will be collected by the
203207
`postgresql.clientparameter.collect` function using "PG" as the
204-
``environ_prefix``:
208+
``environ_prefix`` and the keyword that it will be mapped to:
205209
206210
===================== ======================================
207211
Environment Variable Keyword
@@ -240,13 +244,13 @@
240244
A single asterisk, ``*``, may be used to indicate that any value will match the
241245
field. However, this only effects fields other than ``password``.
242246
243-
See http://www.postgresql.org/docs/8.3/static/libpq-pgpass.html for more
247+
See http://www.postgresql.org/docs/current/static/libpq-pgpass.html for more
244248
details.
245249
246250
Client parameters produced by ``collect`` that have not been processed
247251
by ``resolve_password`` will include a ``'pgpassfile'`` key. This is the value
248-
that ``resolve_password`` will use to locate the pgpassfile to interrogate if it
249-
is not instructed to prompt for a password.
252+
that ``resolve_password`` will use to locate the pgpassfile to interrogate if a
253+
password key is not present and it is not instructed to prompt for a password.
250254
251255
.. warning::
252256
Connection creation interfaces will *not* resolve ``'pgpassfile'``, so it is

0 commit comments

Comments
 (0)