Date: Wed, 24 Feb 2021 14:29:31 +0900
From: Michael Paquier <michael@paquier.xyz>
To: christophe.courtois@dalibo.com, pgsql-docs@lists.postgresql.org
Subject: Re: pgbench: supports PGDATABASE / warning about -d
Message-ID: <YDXkO0HXIwh9ROkD@paquier.xyz>
References: <161399398648.21711.15387267201764682579@wrigleys.postgresql.org>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
	protocol="application/pgp-signature"; boundary="IDp5nWF8U8pckfaz"
Content-Disposition: inline
In-Reply-To: <161399398648.21711.15387267201764682579@wrigleys.postgresql.org>
Precedence: bulk


--IDp5nWF8U8pckfaz
Content-Type: multipart/mixed; boundary="POn96qxKc589seyS"
Content-Disposition: inline


--POn96qxKc589seyS
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Mon, Feb 22, 2021 at 11:39:46AM +0000, PG Doc comments form wrote:
> 1) pgbench has always supported the PGDATABASE env variable, but it is not
> listed along PGHOST/PGPORT & PGUSER  in=20
> https://www.postgresql.org/docs/13/pgbench.html#id-1.9.4.10.8.
> PGDATABASE is listed in the pages of the psql/pg_dump/createdb...
> utilities

Yeah, let's fix that.  Adding only PGDATABASE to the list of
environment variables supported does not look enough to me, so I
propose the simple patch attached to clarify what happens to dbname in
more details.

> 2) In "Common options", it would be useful to add a warning that "-d means
> --debug and does NOT define the database, contrary to most other PostgreS=
QL
> utilities".=20
> (It seems to work and the consequence is a flood of SQL orders on the
> screen.)

I don't agree with this part.
--
Michael

--POn96qxKc589seyS
Content-Type: text/x-diff; charset=us-ascii
Content-Disposition: attachment; filename="pgbench-doc-db.patch"
Content-Transfer-Encoding: quoted-printable

diff --git a/doc/src/sgml/ref/pgbench.sgml b/doc/src/sgml/ref/pgbench.sgml
index faa7c26b0a..2ec0580a79 100644
--- a/doc/src/sgml/ref/pgbench.sgml
+++ b/doc/src/sgml/ref/pgbench.sgml
@@ -151,6 +151,18 @@ pgbench <optional> <replaceable>options</replaceable> =
</optional> <replaceable>d
=20
     <variablelist>
=20
+     <varlistentry>
+      <term><replaceable class=3D"parameter">dbname</replaceable></term>
+      <listitem>
+       <para>
+        Specifies the name of the database to test in. If this is
+        not specified, the environment variable
+        <envar>PGDATABASE</envar> is used. If that is not set, the
+        user name specified for the connection is used.
+       </para>
+      </listitem>
+     </varlistentry>
+
      <varlistentry>
       <term><option>-i</option></term>
       <term><option>--initialize</option></term>
@@ -900,6 +912,7 @@ pgbench <optional> <replaceable>options</replaceable> <=
/optional> <replaceable>d
=20
   <variablelist>
    <varlistentry>
+    <term><envar>PGDATABASE</envar></term>
     <term><envar>PGHOST</envar></term>
     <term><envar>PGPORT</envar></term>
     <term><envar>PGUSER</envar></term>

--POn96qxKc589seyS--

--IDp5nWF8U8pckfaz
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQIzBAABCgAdFiEEG72nH6vTowiyblFKnvQgOdbyQH0FAmA15DsACgkQnvQgOdby
QH2MrRAAonGHxFbXQE/x9KZP4BnnkJWeUfI/Yo9xzsaKhXYZASTPUtm+B/WyNlzP
8COLBNls8sz5wYxFQVrIOTPFXojyYCVxZdsnYdxQ1dAYCPm4wItw7ZE7guLe6RlR
zRFrdtDancwk2lQDkr/Eu1l6aAauOmlV0LYvJ+IskVfFiH64kuRcfpaDYhXAEdmT
qxG/OCEcu8nF9lbCVTQJ7kkQC/8trTuYF4zQ6FDEQAN8qYqEMVH1+zkeSNBSrPUX
0pA+3JgvTMJTPJ7/ciDwWu2F6EDmwLo+eWHIXToGCZiEJJMxUeoHiuwq5vZC9bZu
WUpK+o0rrB0hH/nRT8BCmtqP7oZkF4G263sP4VXLyjoBXwmryhdmxifi+pwQ1piU
b1bULb8NYQC2k7vV4djE8j2SDqn/IoO5kmRmEfuSnTa7a8QPGEvjF3QytTPkZUgi
1z420XHgUpak4b5EH5V37xNZOQX2U4GvaLykI2lo6vBygBeiaC5HZdsNfh2JDYKa
QDiEVAaTsVfT26dul9aFiuQjMCiTfuD4kM7G0oLJ0+fKa9KyKas5B8tGKm37MMv8
IwtE4lm/91uscOmhUAQuWZ3Q5qgQiQiiS7RTrpsvRw//UCx8e/nxnnIBpTB7g5Ki
JuBWcPSuK8LjNSJenF3V4VDLBqCOR/OtGdb6AqEtmz4gUo1wVT0=
=1AJ5
-----END PGP SIGNATURE-----

--IDp5nWF8U8pckfaz--