path: root/doc/src/sgml/ref/vacuumdb.sgml

<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.9 2000/05/02 20:02:03 thomas Exp $
Postgres documentation
-->

<refentry id="APP-VACUUMDB">
 <refmeta>
  <refentrytitle id="APP-VACUUMDB-TITLE">
   <application>vacuumdb</application>
  </refentrytitle>
  <refmiscinfo>Application</refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname id="vacuumdb">
   <application>vacuumdb</application>
  </refname>
  <refpurpose>
   Clean and analyze a <productname>Postgres</productname> database
  </refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <refsynopsisdivinfo>
   <date>1999-12-04</date>
  </refsynopsisdivinfo>
  <synopsis>
vacuumdb [ <replaceable class="parameter">options</replaceable> ] [ --analyze | -z ]
    [ --alldb | -a ] [ --verbose | -v ]
    [ --table '<replaceable class="parameter">table</replaceable> [ ( <replaceable class="parameter">column</replaceable> [,...] ) ]' ] [ [-d] <replaceable class="parameter">dbname</replaceable> ]
  </synopsis>

  <refsect2 id="R2-APP-VACUUMDB-1">
   <refsect2info>
    <date>1999-12-04</date>
   </refsect2info>
   <title>
    Inputs
   </title>
   <para>
    <application>vacuumdb</application> accepts the following command line arguments:
    
    <variablelist>
     <varlistentry>
      <term>-d <replaceable class="parameter">dbname</replaceable></term>
      <term>--dbname <replaceable class="parameter">dbname</replaceable></term>
      <listitem>
       <para>
	Specifies the name of the database to be cleaned or analyzed.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-z</term>
      <term>--analyze</term>
      <listitem>
       <para>
	Calculate statistics on the database for use by the optimizer.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-a</term>
      <term>--alldb</term>
      <listitem>
       <para>
	Vacuum all databases.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-v</term>
      <term>--verbose</term>
      <listitem>
       <para>
	Print detailed information during processing.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-t <replaceable class="parameter">table</replaceable> [ (<replaceable class="parameter">column</replaceable> [,...]) ]</term>
      <term>--table <replaceable class="parameter">table</replaceable> [ (<replaceable class="parameter">column</replaceable> [,...]) ]</term>
      <listitem>
       <para>
	Clean or analyze <replaceable class="parameter">table</replaceable> only.
	Column names may be specified only in conjunction with
	the <option>--analyze</option> option.
       </para>
       <tip>
        <para>
         If you specify columns to vacuum, you probably have to escape the parentheses
         from the shell.
        </para>
       </tip>
      </listitem>
     </varlistentry>

    </variablelist>
   </para>

   <para>
    <application>vacuumdb</application> also accepts 
    the following command line arguments for connection parameters:
    
    <variablelist>
     <varlistentry>
      <term>-h <replaceable class="parameter">host</replaceable></term>
      <term>--host <replaceable class="parameter">host</replaceable></term>
      <listitem>
       <para>
	Specifies the hostname of the machine on which the 
	<application>postmaster</application>
	is running.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-p <replaceable class="parameter">port</replaceable></term>
      <term>--port <replaceable class="parameter">port</replaceable></term>
      <listitem>
       <para>
	Specifies the Internet TCP/IP port or local Unix domain socket file 
	extension on which the <application>postmaster</application>
	is listening for connections.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-U <replaceable class="parameter">username</replaceable></term>
      <term>--username <replaceable class="parameter">username</replaceable></term>
      <listitem>
       <para>
        Username to connect as.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-W</term>
      <term>--password</term>
      <listitem>
       <para>
        Force password prompt.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-e</term>
      <term>--echo</term>
      <listitem>
       <para>
        Echo the commands that <application>vacuumdb</application> generates
	and sends to the backend.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-q</term>
      <term>--quiet</term>
      <listitem>
       <para>
        Do not display a response.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect2>

  <refsect2 id="R2-APP-VACUUMDB-2">
   <refsect2info>
    <date>1999-12-04</date>
   </refsect2info>
   <title>
    Outputs
   </title>
   <para>
    <variablelist>
     <varlistentry>
      <term><computeroutput>VACUUM</computeroutput></term>
      <listitem>
       <para>
        Everything went well.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term><computeroutput>vacuumdb: Vacuum failed.</computeroutput></term>
      <listitem>
       <para>
        Something went wrong. <application>vacuumdb</application> is only a wrapper
        script. See <xref linkend="SQL-VACUUM" endterm="SQL-VACUUM-title">
        and <xref linkend="APP-PSQL" endterm="APP-PSQL-title"> for a detailed
        discussion of error messages and potential problems.
       </para>
      </listitem>
     </varlistentry>

    </variablelist>
   </para>

   <para>
   </para>

  </refsect2>
 </refsynopsisdiv>
 
 <refsect1 id="R1-APP-VACUUMDB-1">
  <refsect1info>
   <date>1999-12-04</date>
  </refsect1info>
  <title>
   Description
  </title>

  <para>
   <application>vacuumdb</application> is a utility for cleaning a
   <productname>Postgres</productname> database.
   <application>vacuumdb</application> will also generate internal statistics
   used by the <productname>Postgres</productname> query optimizer.
  </para>

  <para>
   <application>vacuumdb</application> is a shell script wrapper around the
   backend command
   <xref linkend="SQL-VACUUM" endterm="SQL-VACUUM-title"> via
   the <productname>Postgres</productname> interactive terminal
   <xref linkend="APP-PSQL" endterm="APP-PSQL-title">. There is no effective
   difference between vacuuming databases via this or other methods.
   <application>psql</application> must be found by the script and
   a database server must be running at the targeted host. Also, any default
   settings and environment variables available to <application>psql</application>
   and the <application>libpq</application> front-end library do apply.
  </para>

 </refsect1>

 <refsect1 id="R1-APP-VACUUMDB-3">
  <refsect1info>
   <date>1998-10-04</date>
  </refsect1info>
  <title>
   Usage
  </title>

  <para>
   To clean the database <literal>test</literal>:
<programlisting>
$ vacuumdb test
</programlisting>
  </para>

  <para>
   To analyze a database named <literal>bigdb</literal> for the optimizer:
<programlisting>
$ vacuumdb --analyze bigdb
</programlisting>
  </para>

  <para>
   To analyze a single column <literal>bar</literal> in table <literal>foo</literal>
   in a database named <literal>xyzzy</literal> for the optimizer:
<programlisting>
$ vacuumdb --analyze --verbose --table 'foo(bar)' xyzzy
</programlisting>
  </para>

 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/catalog"
sgml-local-ecat-files:nil
End:
-->