<!--
$Header: /usr/prj/pg/cvsroot/doc/doc/src/sgml/ref/vacuumdb.sgml,v 1.6 2001/09/10 12:49:18 t-ishii Exp $
Postgres documentation
-->

<refentry id="APP-VACUUMDB">
 <docinfo>
  <date>2000-11-11</date>
 </docinfo>

 <refmeta>
  <refentrytitle id="APP-VACUUMDB-TITLE"><application>vacuumdb</application></refentrytitle>
  <manvolnum>1</manvolnum>
  <refmiscinfo><!--Application-->アプリケーション</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname id="vacuumdb">vacuumdb</refname>
  <refpurpose><!--Clean and analyze a <productname>Postgres</productname> database-->
            <productname>Postgres</productname>データベースの不要領域を掃除/解析します。<indexterm><primary>vacuumdb</primary></indexterm><indexterm><primary>PostgreSQL</primary><secondary>vacuumdb</secondary></indexterm><indexterm><primary sortas="でーたべーす">データベース</primary><secondary sortas="ふようりょういきのそうじとかいせき">不要領域の掃除と解析</secondary></indexterm>
  </refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <cmdsynopsis>
   <command>vacuumdb</command>
   <arg rep="repeat"><replaceable>connection-options</replaceable></arg>
   <arg><arg>-d</arg> <replaceable>dbname</replaceable></arg>
   <group><arg>--analyze</arg><arg>-z</arg></group>
   <group><arg>--verbose</arg><arg>-v</arg></group>
   <arg>--table '<replaceable>table</replaceable>
    <arg>( <replaceable class="parameter">column</replaceable> [,...] )</arg>'
   </arg>
   <sbr>
   <command>vacuumdb</command>
   <arg rep="repeat"><replaceable>connection-options</replaceable></arg>
   <group><arg>--all</arg><arg>-a</arg></group>
   <group><arg>--analyze</arg><arg>-z</arg></group>
   <group><arg>--verbose</arg><arg>-v</arg></group>
  </cmdsynopsis>

  <refsect2 id="R2-APP-VACUUMDB-1">
   <title>
    <!--Inputs-->入力
   </title>
   <para>
    <!--<application>vacuumdb</application> accepts the following command line arguments:-->
    <application>vacuumdb</application>では、下記のコマンドライン引数を指定できます。
</para>


    <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.-->
        すべてのデータベースをVacuumします。
       </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-->
       <replaceable class="parameter">table</replaceable>のみの掃除または解析を行います。列名は<option>--analyze</option>オプションがある場合にのみ設定できます。
       </para>
       <tip>
        <para>
         <!--If you specify columns to vacuum, you probably have to escape the parentheses
         from the shell.-->
         vacuumする列を指定する場合は、シェルからかっこをエスケープさせる必要があるかもしれません。
        </para>
       </tip>
      </listitem>
     </varlistentry>

    </variablelist>

   <para>
    <!--<application>vacuumdb</application> also accepts 
    the following command line arguments for connection parameters:-->

    <application>vacuumdb</application>は、下記に記す接続パラメータ用のコマンドライン引数を指定することもできます。
</para>

    <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.  If host begins with a slash, it is used 
	as the directory for the unix domain socket.-->

        <application>postmaster</application>が動作しているマシンのホスト名を指定します。ホストがスラッシュから始まる場合は、Unixドメインソケットのディレクトリとして使用されます。
       </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.-->

        <application>postmaster</application>が接続を監視するインターネットTCP/IPポート、またはローカルUnixドメインソケットファイルの拡張子を指定します。
       </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.-->

        <application>vacuumdb</application>が生成し、バックエンドに送るコマンドを表示させます。
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-q</term>
      <term>--quiet</term>
      <listitem>
       <para>
        <!--Do not display a response.-->
        返答を表示させないようにします。
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
  </refsect2>

  <refsect2 id="R2-APP-VACUUMDB-2">
   <title>
    <!--Outputs-->出力
   </title>
    <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"> for a detailed
        discussion of error messages and potential problems.-->

        異常が発生した場合に返されます。<application>vacuumdb</application>は単にラッパースクリプトです。エラーメッセージと可能性のある問題に関する詳細は<xref linkend="SQL-VACUUM" endterm="SQL-VACUUM-title">と<xref linkend="APP-PSQL">を参照してください。
       </para>
      </listitem>
     </varlistentry>

    </variablelist>


  </refsect2>
 </refsynopsisdiv>
 
 <refsect1 id="R1-APP-VACUUMDB-1">
  <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.-->

   <application>vacuumdb</application>は、<productname>Postgres</productname>データベースの不要領域の掃除を行うユーティリティです。また、<application>vacuumdb</application>は<productname>Postgres</productname>問い合わせオプティマイザで使用される内部的な統計情報も生成します。

  </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">. 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.-->

   <application>vacuumdb</application>は、<productname>Postgres</productname>の対話式端末プログラム<xref linkend="APP-PSQL">を使用して<acronym>SQL</acronym>コマンドの<xref linkend="SQL-VACUUM" endterm="SQL-VACUUM-title">を実行するシェルスクリプトです。従って、このスクリプトを利用しても直接SQLコマンドを実行しても実際には違いはありません。ただし、<application>psql</application>がスクリプトから参照できる場所にあり、データベースサーバーが目的のホストで稼働していなければいけないということに注意してください。また、<application>psql</application>と<application>libpq</application>フロントエンドライブラリが利用する、すべてのデフォルト設定と環境変数が適用されることにも注意してください。
   
  </para>

 </refsect1>

 <refsect1 id="R1-APP-VACUUMDB-3">
  <title><!--Usage-->使用方法</title>

  <informalexample>
   <para>
    <!--To clean the database <literal>test</literal>:-->
    <literal>test</literal>というデータベースを掃除するには以下のようにします。
</para>

<screen>
<prompt>$ </prompt><userinput>vacuumdb test</userinput>
</screen>

  </informalexample>

  <informalexample>
   <para>
    <!--To analyze for the optimzer a database named
    <literal>bigdb</literal>:-->
    オプテイマイザのために、<literal>bigdb</literal>というデータベースの解析を行うには以下のようにします
</para>

<screen>
<prompt>$ </prompt><userinput>vacuumdb --analyze bigdb</userinput>
</screen>
  </informalexample>

  <informalexample>
   <para>
    <!--To analyze a single column <literal>bar</literal> in table
    <literal>foo</literal> in a database named
    <literal>xyzzy</literal> for the optimizer:-->

    オプティマイザのために、<literal>xyzzy</literal>という名前のデータベースの<literal>foo</literal>テーブルのある、<literal>bar</literal>という1つの列に対して解析を行うには以下のようにします
</para>

<screen>
<prompt>$ </prompt><userinput>vacuumdb --analyze --verbose --table 'foo(bar)' xyzzy</userinput>
</screen>
  </informalexample>

 </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:
-->
