NAME
vacuumdb - garbage-collect and analyze a PostgreSQL database
SYNOPSIS
vacuumdb [connection-option...] [option...] [ -t | --tabletable [( column [,...] )] ]... [dbname | -a | --all]
vacuumdb [connection-option...] [option...] [ -n | --schemaschema ]... [dbname | -a | --all]
vacuumdb [connection-option...] [option...] [ -N | --exclude-schemaschema ]... [dbname | -a | --all]
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. 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:
-a --all
--buffer-usage-limitsize
[-d]dbname [--dbname=]dbname
--disable-page-skipping
-e --echo
-f --full
-F --freeze
--force-index-cleanup
-jnjobs --jobs=njobs
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.
--min-mxid-agemxid_age
For the purposes of this option, the multixact ID age of a relation is the greatest of the ages of the main relation and its associated TOAST table, if one exists. Since the commands issued by vacuumdb will also process the TOAST table for the relation if necessary, it does not need to be considered separately.
--min-xid-agexid_age
For the purposes of this option, the transaction ID age of a relation is the greatest of the ages of the main relation and its associated TOAST table, if one exists. Since the commands issued by vacuumdb will also process the TOAST table for the relation if necessary, it does not need to be considered separately.
-nschema --schema=schema
-Nschema --exclude-schema=schema
--no-index-cleanup
--no-process-main
--no-process-toast
--no-truncate
-Pparallel_workers --parallel=parallel_workers
-q --quiet
--skip-locked
-ttable[ (column[,...]) ] --table=table[ (column[,...]) ]
-v --verbose
-V --version
-z --analyze
-Z --analyze-only
--analyze-in-stages
This option is only useful to analyze a database that currently has no statistics or has wholly incorrect ones, such as if it is newly populated from a restored dump or by pg_upgrade. Be aware that running with this option in a database with existing statistics may cause the query optimizer choices to become transiently worse due to the low statistics targets of the early stages.
-? --help
vacuumdb also accepts the following command-line arguments for connection parameters:
-hhost --host=host
-pport --port=port
-Uusername --username=username
-w --no-password
-W --password
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.
--maintenance-db=dbname
ENVIRONMENT
PGDATABASE PGHOST PGPORT PGUSER
PG_COLOR
This utility, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section 32.15).
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.
EXAMPLES
To clean the database test:
$ \nvacuumdb testTo clean and analyze for the optimizer a database named bigdb:
$ \nvacuumdb --analyze bigdbTo clean a single table foo in a database named xyzzy, and analyze a single column bar of the table for the optimizer:
$ \nvacuumdb --analyze --verbose --table='foo(bar)' xyzzyTo clean all tables in the foo and bar schemas in a database named xyzzy:
$ \nvacuumdb --schema='foo' --schema='bar' xyzzySEE ALSO
VACUUM(7)