mirrors
/
postgres
mirror of https://github.com/postgres/postgres
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: libpq connection options can override command-line flags 

Reported-by: Alexander Lakhin

Discussion: https://postgr.es/m/16486-b9c93d71c02c4907@postgresql.org

Backpatch-through: 9.5
This commit is contained in:
Bruce Momjian 2020-10-02 22:19:31 -04:00
parent 472e518a44
commit 1a9388bd0f
11 changed files with 53 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/src/sgml/ref/clusterdb.sgml
View File

@ -95,7 +95,10 @@ PostgreSQL documentation
<option>--all</option>) is not used, the database name is read
from the environment variable <envar>PGDATABASE</envar>. If
that is not set, the user name specified for the connection is
used.
used. The <replaceable>dbname</replaceable> can be a <link
linkend="libpq-connstring">connection string</link>. If so,
connection string parameters will override any conflicting command
line options.
</para>
</listitem>
</varlistentry>

5
doc/src/sgml/ref/pg_basebackup.sgml
View File

@ -653,8 +653,9 @@ PostgreSQL documentation
<term><option>--dbname=<replaceable class="parameter">connstr</replaceable></option></term>
<listitem>
<para>
Specifies parameters used to connect to the server, as a connection
string. See <xref linkend="libpq-connstring"/> for more information.
Specifies parameters used to connect to the server, as a <link
linkend="libpq-connstring">connction string</link>; these
will override any conflicting command line options.
</para>
<para>
The option is called <literal>--dbname</literal> for consistency with other

12
doc/src/sgml/ref/pg_dump.sgml
View File

@ -1132,14 +1132,10 @@ PostgreSQL documentation
Specifies the name of the database to connect to. This is
equivalent to specifying <replaceable
class="parameter">dbname</replaceable> as the first non-option
argument on the command line.
</para>
<para>
If this parameter contains an <symbol>=</symbol> sign or starts
with a valid <acronym>URI</acronym> prefix
(<literal>postgresql://</literal>
or <literal>postgres://</literal>), it is treated as a
<parameter>conninfo</parameter> string. See <xref linkend="libpq-connect"/> for more information.
argument on the command line. The <replaceable>dbname</replaceable>
can be a <link linkend="libpq-connstring">connection string</link>.
If so, connection string parameters will override any conflicting
command line options.
</para>
</listitem>
</varlistentry>

5
doc/src/sgml/ref/pg_dumpall.sgml
View File

@ -552,8 +552,9 @@ PostgreSQL documentation
<term><option>--dbname=<replaceable class="parameter">connstr</replaceable></option></term>
<listitem>
<para>
Specifies parameters used to connect to the server, as a connection
string. See <xref linkend="libpq-connstring"/> for more information.
Specifies parameters used to connect to the server, as a <link
linkend="libpq-connstring">connction string</link>; these
will override any conflicting command line options.
</para>
<para>
The option is called <literal>--dbname</literal> for consistency with other

14
doc/src/sgml/ref/pg_isready.sgml
View File

@ -47,15 +47,11 @@ PostgreSQL documentation
<term><option>--dbname=<replaceable class="parameter">dbname</replaceable></option></term>
<listitem>
<para>
Specifies the name of the database to connect to.
</para>
<para>
If this parameter contains an <symbol>=</symbol> sign or starts
with a valid <acronym>URI</acronym> prefix
(<literal>postgresql://</literal>
or <literal>postgres://</literal>), it is treated as a
<parameter>conninfo</parameter> string. See <xref
linkend="libpq-connstring"/> for more information.
Specifies the name of the database to connect to. The
<replaceable>dbname</replaceable> can be a <link
linkend="libpq-connstring">connection string</link>. If so,
connection string parameters will override any conflicting command
line options.
</para>
</listitem>
</varlistentry>

5
doc/src/sgml/ref/pg_receivewal.sgml
View File

@ -252,8 +252,9 @@ PostgreSQL documentation
<term><option>--dbname=<replaceable class="parameter">connstr</replaceable></option></term>
<listitem>
<para>
Specifies parameters used to connect to the server, as a connection
string. See <xref linkend="libpq-connstring"/> for more information.
Specifies parameters used to connect to the server, as a <link
linkend="libpq-connstring">connction string</link>; these
will override any conflicting command line options.
</para>
<para>
The option is called <literal>--dbname</literal> for consistency with other

14
doc/src/sgml/ref/pg_recvlogical.sgml
View File

@ -273,14 +273,16 @@ PostgreSQL documentation
<variablelist>
<varlistentry>
<term><option>-d <replaceable>database</replaceable></option></term>
<term><option>--dbname=<replaceable>database</replaceable></option></term>
<term><option>-d <replaceable>dbname</replaceable></option></term>
<term><option>--dbname=<replaceable>dbname</replaceable></option></term>
<listitem>
<para>
The database to connect to. See the description of the actions for
what this means in detail. This can be a <application>libpq</application> connection string;
see <xref linkend="libpq-connstring"/> for more information. Defaults
to user name.
The database to connect to. See the description
of the actions for what this means in detail.
The <replaceable>dbname</replaceable> can be a <link
linkend="libpq-connstring">connection string</link>. If so,
connection string parameters will override any conflicting
command line options. Defaults to the user name.
</para>
</listitem>
</varlistentry>

5
doc/src/sgml/ref/pg_restore.sgml
View File

@ -156,7 +156,10 @@ PostgreSQL documentation
<para>
Connect to database <replaceable
class="parameter">dbname</replaceable> and restore directly
into the database.
into the database. The <replaceable>dbname</replaceable> can
be a <link linkend="libpq-connstring">connection string</link>.
If so, connection string parameters will override any conflicting
command line options.
</para>
</listitem>
</varlistentry>

25
doc/src/sgml/ref/psql-ref.sgml
View File

@ -168,15 +168,10 @@ EOF
Specifies the name of the database to connect to. This is
equivalent to specifying <replaceable
class="parameter">dbname</replaceable> as the first non-option
argument on the command line.
</para>
<para>
If this parameter contains an <symbol>=</symbol> sign or starts
with a valid <acronym>URI</acronym> prefix
(<literal>postgresql://</literal>
or <literal>postgres://</literal>), it is treated as a
<parameter>conninfo</parameter> string. See <xref
linkend="libpq-connstring"/> for more information.
argument on the command line. The <replaceable>dbname</replaceable>
can be a <link linkend="libpq-connstring">connection string</link>.
If so, connection string parameters will override any conflicting
command line options.
</para>
</listitem>
</varlistentry>
@ -498,7 +493,7 @@ EOF
<listitem>
<para>
Never issue a password prompt. If the server requires password
authentication and a password is not available by other means
authentication and a password is not available from other sources
such as a <filename>.pgpass</filename> file, the connection
attempt will fail. This option can be useful in batch jobs and
scripts where no user is present to enter a password.
@ -518,13 +513,15 @@ EOF
<listitem>
<para>
Force <application>psql</application> to prompt for a
password before connecting to a database.
password before connecting to a database, even if the password will
not be used.
</para>
<para>
This option is never essential, since <application>psql</application>
will automatically prompt for a password if the server demands
password authentication. However, <application>psql</application>
If the server requires password authentication and a password is not
available from other sources such as a <filename>.pgpass</filename>
file, <application>psql</application> will prompt for a
password in any case. However, <application>psql</application>
will waste a connection attempt finding out that the server wants a
password. In some cases it is worth typing <option>-W</option> to avoid
the extra connection attempt.

5
doc/src/sgml/ref/reindexdb.sgml
View File

@ -139,7 +139,10 @@ PostgreSQL documentation
<option>--all</option>) is not used, the database name is read
from the environment variable <envar>PGDATABASE</envar>. If
that is not set, the user name specified for the connection is
used.
used. The <replaceable>dbname</replaceable> can be a <link
linkend="libpq-connstring">connection string</link>. If so,
connection string parameters will override any conflicting command
line options.
</para>
</listitem>
</varlistentry>

5
doc/src/sgml/ref/vacuumdb.sgml
View File

@ -97,7 +97,10 @@ PostgreSQL documentation
<option>--all</option>) is not used, the database name is read
from the environment variable <envar>PGDATABASE</envar>. If
that is not set, the user name specified for the connection is
used.
used. The <replaceable>dbname</replaceable> can be a <link
linkend="libpq-connstring">connection string</link>. If so,
connection string parameters will override any conflicting command
line options.
</para>
</listitem>
</varlistentry>