|
6 | 6 | Client Parameters |
7 | 7 | ***************** |
8 | 8 |
|
| 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 | +
|
9 | 13 | Connection creation interfaces in `postgresql.driver` are purposefully simple. |
10 | 14 | All parameters taken by those interfaces are keywords, and are taken |
11 | 15 | literally; if a parameter is not given, it will effectively be `None`. |
|
201 | 205 |
|
202 | 206 | The following is a list of environment variables that will be collected by the |
203 | 207 | `postgresql.clientparameter.collect` function using "PG" as the |
204 | | -``environ_prefix``: |
| 208 | +``environ_prefix`` and the keyword that it will be mapped to: |
205 | 209 |
|
206 | 210 | ===================== ====================================== |
207 | 211 | Environment Variable Keyword |
|
240 | 244 | A single asterisk, ``*``, may be used to indicate that any value will match the |
241 | 245 | field. However, this only effects fields other than ``password``. |
242 | 246 |
|
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 |
244 | 248 | details. |
245 | 249 |
|
246 | 250 | Client parameters produced by ``collect`` that have not been processed |
247 | 251 | 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. |
250 | 254 |
|
251 | 255 | .. warning:: |
252 | 256 | Connection creation interfaces will *not* resolve ``'pgpassfile'``, so it is |
|
0 commit comments