Unix‎ > ‎Solaris‎ > ‎Solaris man pages‎ > ‎1‎ > ‎


     vacuumdb - garbage-collect and analyze a PostgreSQL database

     vacuumdb [ connection-option... ]  [  [ --full ]  [ -f ]   ]
     [   [ --verbose ]  [ -v ]  ]  [  [ --analyze ]  [ -z ]  ]  [
     --table | -t table
      [ ( column [,...] ) ]
      ]  [ dbname ]

     vacuumdb [ connection-options... ]  [  [ --all ]  [ -a ]   ]
     [   [ --full ]  [ -f ]  ]  [  [ --verbose ]  [ -v ]  ]  [  [
     --analyze ]  [ -z ]  ]

     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
     [vacuum(5)].  There is no effective difference between vacu-
     uming databases via this utility and via other  methods  for
     accessing the server.

     vacuumdb accepts the following command-line arguments:


          Vacuum all databases.

     [-d] dbname

     [--dbname] dbname
          Specifies the name of the database  to  be  cleaned  or
          analyzed.   If  this is not specified and -a (or --all)
          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.


          Do not display a response.

     -t table [ (column [,...]) ]

     --table table [ (column [,...]) ]
          Clean or analyze  table  only.   Column  names  may  be
          specified   only  in  conjunction  with  the  --analyze

          Tip: If you  specify  columns,  you  probably  have  to
          escape  the  parentheses  from the shell. (See examples


          Print detailed information during processing.


          Calculate statistics for use by the optimizer.

     vacuumdb also accepts the following  command-line  arguments
     for connection parameters:

     -h host

     --host host
          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.

     -p port

     --port port
          Specifies the TCP port or local Unix domain socket file
          extension  on which the server is listening for connec-

     -U username

     --username username
          User name to connect as


          Force password prompt.




          Default connection parameters

     In case of difficulty, see VACUUM  [vacuum(5)]  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 vari-
     ables used by the libpq front-end library will apply.

     vacuumdb might need to connect several times  to  the  Post-
     greSQL  server,  asking for a password each time. It is con-
     venient to have a ~/.pgpass file  in  such  cases.  See  the
     documentation for more information.

     To clean the database test:

     $ vacuumdb test

     To clean and analyze for  the  optimizer  a  database  named

     $ 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

     VACUUM [vacuum(5)], Environment  Variables  (the  documenta-

Man pages from Solaris 10 Update 8. See docs.sun.com and www.oracle.com for further documentation and Solaris information.