- buster 11.9-0+deb10u1
|VACUUMDB(1)||PostgreSQL 11.9 Documentation||VACUUMDB(1)|
NAME¶vacuumdb - garbage-collect and analyze a PostgreSQL database
vacuumdb [connection-option...] [option...] [ --table | -t table [( column [,...] )] ]... [dbname]
vacuumdb [connection-option...] [option...] --all | -a
DESCRIPTION¶vacuumdb 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 VACUUM(7). There is no effective difference between vacuuming and analyzing databases via this utility and via other methods for accessing the server.
OPTIONS¶vacuumdb accepts the following command-line arguments:
vacuumdb will open njobs connections to the database, so make sure your max_connections setting is high enough to accommodate all connections.
Note that using this mode together with the -f (FULL) option might cause deadlock failures if certain system catalogs are processed in parallel.
-t table [ (column
--table=table [ (column [,...]) ]
If you specify columns, you probably have to escape the parentheses from the shell. (See examples below.)
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.
vacuumdb also accepts the following command-line arguments for connection parameters:
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 -W to avoid the extra connection attempt.
This utility, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section 34.14).
DIAGNOSTICS¶In case of difficulty, see VACUUM(7) and psql(1) 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.
NOTES¶vacuumdb 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 Section 34.15 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)' xyzzy