vacuumdbvacuumdb1Applicationvacuumdbgarbage-collect and analyze a PostgreSQL databasevacuumdbconnection-optionoptiontable( column [,...] )dbnamevacuumdbconnection-optionoptionDescriptionvacuumdb is a utility for cleaning a
PostgreSQL database.
vacuumdb will also generate internal statistics
used by the PostgreSQL query optimizer.
vacuumdb is a wrapper around the SQL
command .
There is no effective difference between vacuuming and analyzing
databases via this utility and via other methods for accessing the
server.
Optionsvacuumdb accepts the following command-line arguments:
Vacuum all databases.
Specifies the name of the database to be cleaned or analyzed.
If this is not specified and (or
) is not used, the database name is read
from the environment variable PGDATABASE. If
that is not set, the user name specified for the connection is
used.
Echo the commands that vacuumdb generates
and sends to the server.
Perform full vacuuming.
Aggressively freeze tuples.
Execute the vacuum or analyze commands in parallel by running
njobs
commands simultaneously. This option reduces the time of the
processing but it also increases the load on the database server.
vacuumdb will open
njobs connections to the
database, so make sure your
setting is high enough to accommodate all connections.
Note that using this mode together with the
(FULL) option might cause deadlock failures if
certain system catalogs are processed in parallel.
Do not display progress messages.
Clean or analyze table only.
Column names can be specified only in conjunction with
the or options.
Multiple tables can be vacuumed by writing multiple
If you specify columns, you probably have to escape the parentheses
from the shell. (See examples below.)
Print detailed information during processing.
Print the vacuumdb version and exit.
Also calculate statistics for use by the optimizer.
Only calculate statistics for use by the optimizer (no vacuum).
Only calculate statistics for use by the optimizer (no vacuum),
like . Run several (currently three)
stages of analyze with different configuration settings, to produce
usable statistics faster.
This option is useful to analyze a database that was newly populated
from a restored dump or by pg_upgrade. This option
will try to create some statistics as fast as possible, to make the
database usable, and then produce full statistics in the subsequent
stages.
Show help about vacuumdb command line
arguments, and exit.
vacuumdb also accepts
the following command-line arguments for connection parameters:
Specifies the host name of the machine on which the server
is running. If the value begins with a slash, it is used
as the directory for the Unix domain socket.
Specifies the TCP port or local Unix domain socket file
extension on which the server
is listening for connections.
User name to connect as.
Never issue a password prompt. If the server requires
password authentication and a password is not available by
other means such as a .pgpass 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.
Force vacuumdb to prompt for a
password before connecting to a database.
This option is never essential, since
vacuumdb will automatically prompt
for a password if the server demands password authentication.
However, vacuumdb will waste a
connection attempt finding out that the server wants a password.
In some cases it is worth typing
Specifies the name of the database to connect to discover what other
databases should be vacuumed. If not specified, the
postgres database will be used,
and if that does not exist, template1 will be used.
EnvironmentPGDATABASEPGHOSTPGPORTPGUSER
Default connection parameters
This utility, like most other PostgreSQL> utilities,
also uses the environment variables supported by libpq>
(see ).
Diagnostics
In case of difficulty, see
and for
discussions of potential problems and error messages.
The database server must be running at the
targeted host. Also, any default connection settings and environment
variables used by the libpq front-end
library will apply.
Notesvacuumdb might need to connect several
times to the PostgreSQL server, asking
for a password each time. It is convenient to have a
~/.pgpass> file in such cases. See for more information.
Examples
To clean the database test:
$ vacuumdb test
To clean and analyze for the optimizer a database named
bigdb:
$ vacuumdb --analyze bigdb
To clean a single table
foo in a database named
xyzzy, and analyze a single column
bar of the table for the optimizer:
$ vacuumdb --analyze --verbose --table='foo(bar)' xyzzySee Also