To: "pgsql-hackers@postgresql.org" <pgsql-hackers@postgresql.org>,
 pgsql-docs@postgresql.org
From: Ian Barwick <ian@2ndquadrant.com>
Subject: Description tweak for vacuumdb
Message-ID: <5689D374.7080703@2ndquadrant.com>
Date: Mon, 4 Jan 2016 11:05:40 +0900
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:38.0) Gecko/20100101
 Thunderbird/38.4.0
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="------------010404010001090304030804"
Precedence: bulk
Sender: pgsql-docs-owner@postgresql.org

This is a multi-part message in MIME format.
--------------010404010001090304030804
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit

Hi

Like the docs say, vacuumdb is a "wrapper around the SQL command VACUUM"
which I used to use in dim-and-distant pre-autovacuum days came for cronjobs,
but until messing around with pg_upgrade recently I hadn't really had much
use for it. Anyway, the docs also say "There is no effective difference
between vacuuming and analyzing databases via this utility and via other
methods for accessing the server", which IMHO seems a bit out-of-date as
it now does two things which you can't do directly via e.g. psql:

- generate statistics in stages (9.4)
- parallel vacuum (9.5)

Attached patches (for 9.4 and 9.5/HEAD) update the description to make
clear that it now does a bit more than just execute a single command.


Regards

Ian Barwick


-- 
 Ian Barwick                   http://www.2ndQuadrant.com/
 PostgreSQL Development, 24x7 Support, Training & Services

--------------010404010001090304030804
Content-Type: text/x-patch;
 name="doc-vacuumdb-94.patch"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: attachment;
 filename="doc-vacuumdb-94.patch"

diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml
new file mode 100644
index 3ecd999..35e3d6f
*** a/doc/src/sgml/ref/vacuumdb.sgml
--- b/doc/src/sgml/ref/vacuumdb.sgml
*************** PostgreSQL documentation
*** 65,71 ****
     command <xref linkend=3D"SQL-VACUUM">.
     There is no effective difference between vacuuming and analyzing
     databases via this utility and via other methods for accessing the
!    server.
    </para>
=20=20
   </refsect1>
--- 65,73 ----
     command <xref linkend=3D"SQL-VACUUM">.
     There is no effective difference between vacuuming and analyzing
     databases via this utility and via other methods for accessing the
!    server. However it does provide additional functionality for generating
!    statistics in stages, which is useful when optimizing a newly populated
!    database.
    </para>
=20=20
   </refsect1>

--------------010404010001090304030804
Content-Type: text/x-patch;
 name="doc-vacuumdb-head.patch"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: attachment;
 filename="doc-vacuumdb-head.patch"

diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml
new file mode 100644
index 92b8984..d640887
*** a/doc/src/sgml/ref/vacuumdb.sgml
--- b/doc/src/sgml/ref/vacuumdb.sgml
*************** PostgreSQL documentation
*** 65,71 ****
     command <xref linkend=3D"SQL-VACUUM">.
     There is no effective difference between vacuuming and analyzing
     databases via this utility and via other methods for accessing the
!    server.
    </para>
=20=20
   </refsect1>
--- 65,73 ----
     command <xref linkend=3D"SQL-VACUUM">.
     There is no effective difference between vacuuming and analyzing
     databases via this utility and via other methods for accessing the
!    server. However it does provide additional functionality for generating
!    statistics in stages, which is useful when optimizing a newly populated
!    database, and for executing vacuum or analyze commands in parallel.
    </para>
=20=20
   </refsect1>

--------------010404010001090304030804
Content-Type: text/plain
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0


-- 
Sent via pgsql-docs mailing list (pgsql-docs@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs

--------------010404010001090304030804--