<!--
$Header: /usr/prj/pg/cvsroot/doc/doc/src/sgml/ref/pg_dumpall.sgml,v 1.5 2001/08/15 08:37:57 i-kaori Exp $
Postgres documentation
-->

<refentry id="APP-PG-DUMPALL">
 <docinfo>
  <date>2000-12-19</date>
 </docinfo>

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

 <refnamediv>
  <refname>pg_dumpall</refname>
  <refpurpose><!-- Extract all databases into a script file -->
   すべてのデータベースをスクリプトファイルに抽出します。<indexterm><primary>pg_dumpall</primary></indexterm><indexterm><primary>PostgreSQL</primary><secondary>pg_dumpall</secondary></indexterm><indexterm><primary sortas="でーたべーす">データベース</primary><secondary sortas="だんぷ">ダンプ</secondary></indexterm><indexterm><primary sortas="でーたべーす">データベース</primary><secondary sortas="ばっくあっぷ">バックアップ</secondary></indexterm><indexterm><primary sortas="ばっくあっぷ">バックアップ</primary></indexterm>

  </refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <cmdsynopsis>
   <command>pg_dumpall</command>
   <group><arg>-c</arg><arg>--clean</arg></group>
   <arg>-h <replaceable>host</replaceable></arg>
   <arg>-p <replaceable>port</replaceable></arg>
   <group><arg>-g</arg><arg>--globals-only</arg></group>
  </cmdsynopsis>
 </refsynopsisdiv>

 <refsect1 id="app-pg-dumpall-description">
  <title><!-- Description -->説明</title>

  <para>
   <!-- 
   <application>pg_dumpall</application> is a utility for writing out
   (<quote>dumping</quote>) all Postgres databases of a cluster into
   one script file.  The script file contains SQL commands that can be
   used as input to <xref linkend="app-psql">
   to restore the databases.  It does this by calling <xref
   linkend="app-pgdump"> for each database
   in a cluster.  <application>pg_dumpall</application> also dumps
   global objects that are common to all databases.
   (<application>pg_dump</application> does not save these objects.)
   This currently includes the information about database users and
   groups. -->

   <application>pg_dumpall</application>はクラスタのすべてのPostgresデータベースを1つのスクリプトファイルに書き出す（<quote>ダンプする</quote>）ための機能です。スクリプトファイルにはデータベースをリストアするための<xref linkend="app-psql">への入力値として使うことができるSQLコマンドが含まれています。これはクラスタのそれぞれのデータベースの<xref linkend="app-pgdump">を呼び出すことによって行われます。<application>pg_dumpall</application>はさらに、すべてのデータベースに共通するグローバルオブジェクトもダンプします（<application>pg_dump</application>はこれらのオブジェクトを保存しません）。これは、現時点ではデータベースユーザーとグループに関する情報を含んでいます。
   
  </para>

  <para>
   <!-- 
   Thus, <application>pg_dumpall</application> is an integrated
   solution for backing up your databases. -->

   したがって、<application>pg_dumpall</application>はデータベースのバックアップをとるための統合解決法です。

  </para>

  <para>
   <!-- 
   Since <application>pg_dumpall</application> reads tables from all
   databases you will most likely have to connect as a database
   superuser in order to produce a complete dump.  Also you will need
   superuser privileges to execute the saved script in order to be
   allowed to add users and groups, and to create databases. -->

   <application>pg_dumpall</application>はすべてのデータベースからテーブルを読み込むため、完全なダンプを作成するためにはデータベースのスーパーユーザーとして接続しなければいけないでしょう。さらに、ユーザーとグループを追加することを許可されるために保存されたスクリプトを実行するため、そしてデータベースを作成するためにはスーパーユーザー権限が必要になるでしょう。

  </para>

  <para>
   <!-- 
   The SQL script will be written to the standard ouput.  Shell
   operators should be used to redirect it into a file. -->

   SQLスクリプトは標準出力に出力されますので、シェル演算子を使ってファイルにリダイレクトします。
   
  </para>

  <refsect2>
   <title><!-- Options -->オプション</title>

   <para>
    <!-- 
    <application>pg_dumpall</application> accepts the following
    command line arguments: -->

    <application>pg_dumpall</application>は以下のコマンドライン引数を受け付けます。

    <variablelist>
     <varlistentry>
      <term>-c, --clean</term>
      <listitem>
       <para>
	<!-- Clean (drop) database before creating schema. -->
        スキーマを作る前にデータベースを掃除（削除）します。
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-h <replaceable>host</replaceable></term>
      <listitem>
       <para>
        <!-- 
	Specifies the hostname of the machine on which the database
	server is running.  If host begins with a slash, it is used as
	the directory for the Unix domain socket.  The default is
	taken from the <envar>PGHOST</envar> environment variable, if
	set, else a Unix domain socket connection is attempted. -->

        データベースサーバーが稼働しているマシンのホスト名を指定します。もしホスト名がスラッシュ「/」で始まる場合は、Unixドメインソケット用のディレクトリとして使われます。設定されている場合、デフォルトは環境変数<envar>PGHOST</envar>からとられますが、そうでない場合はUnixドメインソケット接続を試みます。

       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-p <replaceable>port</replaceable></term>
      <listitem>
       <para>
        <!-- 
        The port number on which the server is listening.  Defaults to
        the <envar>PGPORT</envar> environment variable, if set, or a
        compiled-in default. -->
        サーバーが監視しているポート番号です。デフォルトは、設定されている場合は環境変数<envar>PGPORT</envar>、またはコンパイルされているデフォルトになります。

       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>-g, --globals-only</term>
      <listitem>
       <para>
        <!-- 
	Only dump global objects (users and groups), no databases.
        -->
        グローバルオブジェクト（ユーザーとグループ）のみをダンプし、データベースはダンプしません。

       </para>
      </listitem>
     </varlistentry>

    </variablelist>
   </para>

   <para>
    <!--  
    Any other command line parameters are passed to the underlying
    <xref linkend="app-pgdump">
    calls.  This is useful to control some aspects of the output
    format, but some options such as <option>-f</option>,
    <option>-t</option>, and <replaceable
    class="parameter">dbname</replaceable> should be avoided. -->

    その他すべてのコマンドラインパラメータは元になる<xref linkend="app-pgdump">の呼び出しに渡されます。これは出力フォーマットのいくつかの側面を管理するために便利ですが、<option>-f</option>、<option>-t</option>、<replaceable class="parameter">dbname</replaceable>のようないくつかのオプションは避けるべきです。

   </para>
  </refsect2>
 </refsect1>

 <refsect1 id="app-pg-dumpall-usage">
  <title><!-- Usage -->使用方法</title>
  <para>
   <!-- To dump all databases: -->
   すべてのデータベースを書き出す場合、以下のようにします。

<screen>
<prompt>$</prompt> <userinput>pg_dumpall &gt; db.out</userinput>
</screen>
  </para>

  <para>
   <!-- To reload this database use, for example: -->
   書き出したデータベースを読み込む場合、以下のようにします。
<screen>
<prompt>$</prompt> <userinput>psql -f db.out template1</userinput>
</screen>
    <!-- 
   (It is not important to which database you connect here since the
   script file created by <application>pg_dumpall</application> will
   contain the appropriate commands to create and connect to the saved
   databases.) -->

    ここではどのデータベースに接続するかということは重要ではありません。なぜなら、<application>pg_dumpall</application>が作成するスクリプトファイルは、保存されたデータベースの作成または接続をするのにふさわしいコマンドを含んでいるからです。

  </para>
 </refsect1>

 <refsect1>
  <title><!-- See Also -->参照</title>

  <para>
    <!-- <xref linkend="app-pgdump">, <xref linkend="app-psql">.  Check
    there for details on possible error conditions. -->

    エラー条件についての詳細は<xref linkend="app-pgdump">と<xref linkend="app-psql">を参照してください。

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