Add pgpool_adm Japanese docs.

Also fix some pgpool_adm English docs.

diff --git a/doc.ja/src/figures/pgpool_adm.gif b/doc.ja/src/figures/pgpool_adm.gif
new file mode 100644 (file)
index 0000000..8ed6600
Binary files /dev/null and b/doc.ja/src/figures/pgpool_adm.gif differ

diff --git a/doc.ja/src/figures/pgpool_adm.odp b/doc.ja/src/figures/pgpool_adm.odp
new file mode 100644 (file)
index 0000000..ef4877f
Binary files /dev/null and b/doc.ja/src/figures/pgpool_adm.odp differ

diff --git a/doc.ja/src/figures/pgpool_adm.png b/doc.ja/src/figures/pgpool_adm.png
new file mode 100644 (file)
index 0000000..f9f265b
Binary files /dev/null and b/doc.ja/src/figures/pgpool_adm.png differ

diff --git a/doc.ja/src/sgml/ref/allfiles.sgml b/doc.ja/src/sgml/ref/allfiles.sgml
index 8a2105c1f304532985f9cc60e6c57e8a2beae36a..d20fde677d4ab4f437f12c0852b315c8732aed6e 100644 (file)
--- a/doc.ja/src/sgml/ref/allfiles.sgml
+++ b/doc.ja/src/sgml/ref/allfiles.sgml
@@ -29,3 +29,8 @@ Complete list of usable sgml source files in this directory.
 <!ENTITY showPoolPools       SYSTEM "show_pool_pools.sgml">
 <!ENTITY showPoolVersion     SYSTEM "show_pool_version.sgml">
 <!ENTITY showPoolCache       SYSTEM "show_pool_cache.sgml">
+<!ENTITY pgpoolAdmPcpNodeInfo SYSTEM "pgpool_adm_pcp_node_info.sgml">
+<!ENTITY pgpoolAdmPcpPoolStatus SYSTEM "pgpool_adm_pcp_pool_status.sgml">
+<!ENTITY pgpoolAdmPcpNodeCount SYSTEM "pgpool_adm_pcp_node_count.sgml">
+<!ENTITY pgpoolAdmPcpAttachNode SYSTEM "pgpool_adm_pcp_attach_node.sgml">
+<!ENTITY pgpoolAdmPcpDetachNode SYSTEM "pgpool_adm_pcp_detach_node.sgml">

diff --git a/doc.ja/src/sgml/ref/pgpool_adm_pcp_attach_node.sgml b/doc.ja/src/sgml/ref/pgpool_adm_pcp_attach_node.sgml
new file mode 100644 (file)
index 0000000..02372b6
--- /dev/null
+++ b/doc.ja/src/sgml/ref/pgpool_adm_pcp_attach_node.sgml
@@ -0,0 +1,134 @@
+<!--
+doc/src/sgml/ref/pgpool_adm_pcp_attach_node.sgml
+Pgpool-II documentation
+-->
+
+<refentry id="PGPOOL-ADM-PCP-ATTACH-NODE">
+ <indexterm zone="pgpool-adm-pcp-attach-node">
+  <primary>pgpool_adm_pcp_attach_node</primary>
+ </indexterm>
+
+ <refmeta>
+  <refentrytitle>pgpool_adm_pcp_attach_node</refentrytitle>
+  <manvolnum>3</manvolnum>
+  <refmiscinfo>pgpool_adm extension</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+  <refname>pgpool_adm_pcp_attach_node</refname>
+  <refpurpose>
+<!--
+       a function to attach given node ID
+-->
+指定ノードをアタッチする関数
+  </refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+   <funcsynopsis>
+     <funcprototype>
+       <funcdef><function>pcp_attach_node</function> returns record</funcdef>
+       <paramdef>integer <parameter>node_id</parameter></paramdef>
+       <paramdef>text <parameter>host</parameter></paramdef>
+       <paramdef>integer <parameter>port</parameter></paramdef>
+       <paramdef>text <parameter>username</parameter></paramdef>
+       <paramdef>text <parameter>password</parameter></paramdef>
+       <paramdef>out <parameter>node_attached boolean</parameter></paramdef>
+     </funcprototype>
+     
+     <funcprototype>
+       <funcdef><function>pcp_attach_node</function> returns record</funcdef>
+       <paramdef>integer <parameter>node_id</parameter></paramdef>
+       <paramdef>text <parameter>pcp_server</parameter></paramdef>
+       <paramdef>out <parameter>node_attached boolean</parameter></paramdef>
+     </funcprototype>
+
+   </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id="R3-PCP-ATTACH-NODE-3">
+<!--
+  <title>Description</title>
+-->
+  <title>説明</title>
+  <para>
+<!--
+    <function>pcp_attach_node</function> attaches a node
+    to <productname>Pgpool-II</productname>.
+-->
+<function>pcp_attach_node</function>は、ノードを<productname>Pgpool-II</productname>にアタッチします。
+  </para>
+ </refsect1>
+
+ <refsect1>
+<!--
+  <title>Arguments</title>
+-->
+  <title>引数</title>
+   <para>
+    <variablelist>
+
+     <varlistentry>
+      <term><replaceable class="parameter">node_id</replaceable></term>
+      <listitem>
+       <para>
+<!--
+        The index of backend node to attach.
+-->
+ノードをアタッチするバックエンドのインデックスです。
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><replaceable class="parameter">pcp_server</replaceable></term>
+      <listitem>
+       <para>
+<!--
+         The foreign server name for pcp server.
+-->
+pcpサーバの外部サーバ名
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+<!--
+      <term><option>Other arguments </option></term>
+-->
+      <term><option>他の引数</option></term>
+      <listitem>
+       <para>
+<!--
+        See <xref linkend="pcp-common-options">.
+-->
+<xref linkend="pcp-common-options">を参照ください。
+       </para>
+      </listitem>
+     </varlistentry>
+    </variablelist>
+   </para>
+ </refsect1>
+
+ <refsect1>
+<!--
+  <title>Example</title>
+-->
+  <title>使用例</title>
+   <para>
+<!--
+       Here is an example output:
+-->
+使用例です。
+       <programlisting>
+test=# SELECT * FROM pcp_attach_node(1,'localhost',11001,'t-ishii','t-ishii');
+ node_attached 
+---------------
+ t
+(1 row)
+    </programlisting>
+  </para>
+
+ </refsect1>
+
+</refentry>

diff --git a/doc.ja/src/sgml/ref/pgpool_adm_pcp_detach_node.sgml b/doc.ja/src/sgml/ref/pgpool_adm_pcp_detach_node.sgml
new file mode 100644 (file)
index 0000000..a688ea8
--- /dev/null
+++ b/doc.ja/src/sgml/ref/pgpool_adm_pcp_detach_node.sgml
@@ -0,0 +1,149 @@
+<!--
+doc/src/sgml/ref/pgpool_adm_pcp_detach_node.sgml
+Pgpool-II documentation
+-->
+
+<refentry id="PGPOOL-ADM-PCP-DETACH-NODE">
+ <indexterm zone="pgpool-adm-pcp-detach-node">
+  <primary>pgpool_adm_pcp_detach_node</primary>
+ </indexterm>
+
+ <refmeta>
+  <refentrytitle>pgpool_adm_pcp_detach_node</refentrytitle>
+  <manvolnum>3</manvolnum>
+  <refmiscinfo>pgpool_adm extension</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+  <refname>pgpool_adm_pcp_detach_node</refname>
+  <refpurpose>
+<!--
+    a function to detach given node ID
+  -->
+指定ノードをデタッチする関数
+  </refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+   <funcsynopsis>
+     <funcprototype>
+       <funcdef><function>pcp_detach_node</function> returns record</funcdef>
+       <paramdef>integer <parameter>node_id</parameter></paramdef>
+       <paramdef>boolean <parameter>gracefully</parameter></paramdef>
+       <paramdef>text <parameter>host</parameter></paramdef>
+       <paramdef>integer <parameter>port</parameter></paramdef>
+       <paramdef>text <parameter>username</parameter></paramdef>
+       <paramdef>text <parameter>password</parameter></paramdef>
+       <paramdef>out <parameter>node_detached boolean</parameter></paramdef>
+     </funcprototype>
+     
+     <funcprototype>
+       <funcdef><function>pcp_detach_node</function> returns record</funcdef>
+       <paramdef>integer <parameter>node_id</parameter></paramdef>
+       <paramdef>boolean <parameter>gracefully</parameter></paramdef>
+       <paramdef>text <parameter>pcp_server</parameter></paramdef>
+       <paramdef>out <parameter>node_detached boolean</parameter></paramdef>
+     </funcprototype>
+
+   </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id="R3-PCP-DETACH-NODE-3">
+<!--
+  <title>Description</title>
+-->
+  <title>説明</title>
+  <para>
+<!--    
+    <function>pcp_detach_node</function> detaches a node
+    from <productname>Pgpool-II</productname>.
+-->
+    <function>pcp_detach_node</function>はノードを<productname>Pgpool-II</productname>からデタッチします。
+  </para>
+ </refsect1>
+
+ <refsect1>
+<!--
+  <title>Arguments</title>
+-->
+  <title>引数</title>
+   <para>
+    <variablelist>
+
+     <varlistentry>
+      <term><replaceable class="parameter">node_id</replaceable></term>
+      <listitem>
+       <para>
+<!--
+        The index of backend node to detach.
+-->
+ノードをデタッチするバックエンドのインデックスです。
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><replaceable class="parameter">gracefully</replaceable></term>
+      <listitem>
+       <para>
+<!--
+         If true, wait for all session
+         of <productname>pgpool-II</productname> terminates.
+-->
+もし真なら<productname>pgpool-II</productname>のすべてのセッションが終了するまで待ちます。
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><replaceable class="parameter">pcp_server</replaceable></term>
+      <listitem>
+       <para>
+<!--
+         The foreign server name for pcp server.
+-->
+pcpサーバの外部サーバ名
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+<!--
+      <term><option>Other arguments </option></term>
+-->
+      <term><option>他の引数</option></term>
+      <listitem>
+       <para>
+<!--
+        See <xref linkend="pcp-common-options">.
+-->
+<xref linkend="pcp-common-options">を参照ください。
+       </para>
+      </listitem>
+     </varlistentry>
+    </variablelist>
+   </para>
+ </refsect1>
+
+ <refsect1>
+<!--
+  <title>Example</title>
+-->
+  <title>使用例</title>
+   <para>
+<!--
+       Here is an example output:
+-->
+使用例です。
+       <programlisting>
+test=# SELECT * FROM pcp_detach_node(1, 'false', 'localhost',11001,'t-ishii','t-ishii');
+ node_detached 
+---------------
+ t
+(1 row)
+    </programlisting>
+  </para>
+
+ </refsect1>
+
+</refentry>

diff --git a/doc.ja/src/sgml/ref/pgpool_adm_pcp_node_count.sgml b/doc.ja/src/sgml/ref/pgpool_adm_pcp_node_count.sgml
new file mode 100644 (file)
index 0000000..f0790f6
--- /dev/null
+++ b/doc.ja/src/sgml/ref/pgpool_adm_pcp_node_count.sgml
@@ -0,0 +1,114 @@
+<!--
+doc/src/sgml/ref/pgpool_adm_pcp_node_count.sgml
+Pgpool-II documentation
+-->
+
+<refentry id="PGPOOL-ADM-PCP-NODE-COUNT">
+ <indexterm zone="pgpool-adm-pcp-node-count">
+  <primary>pgpool_adm_pcp_node_count</primary>
+ </indexterm>
+
+ <refmeta>
+  <refentrytitle>pgpool_adm_pcp_node_count</refentrytitle>
+  <manvolnum>3</manvolnum>
+  <refmiscinfo>pgpool_adm extension</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+  <refname>pgpool_adm_pcp_node_count</refname>
+  <refpurpose>
+<!--
+    a function to retrieves number of backend nodes.
+-->
+ノード数を取得する関数
+  </refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+   <funcsynopsis>
+     <funcprototype>
+       <funcdef><function>pcp_node_count</function> returns integer</funcdef>
+       <paramdef>text <parameter>host</parameter></paramdef>
+       <paramdef>integer <parameter>port</parameter></paramdef>
+       <paramdef>text <parameter>username</parameter></paramdef>
+       <paramdef>text <parameter>password</parameter></paramdef>
+     </funcprototype>
+
+     <funcprototype>
+       <funcdef><function>pcp_node_count</function> returns integer</funcdef>
+       <paramdef>text <parameter>pcp_server</parameter></paramdef>
+     </funcprototype>
+
+   </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id="R3-PCP-NODE-COUNT-3">
+  <title>Description</title>
+  <para>
+<!--
+    <function>pcp_node_count</function> retrieves number of DB nodes.
+-->
+<function>pcp_node_count</function>はDBノードの数を取得します。
+  </para>
+ </refsect1>
+
+ <refsect1>
+<!--
+  <title>Arguments</title>
+-->
+  <title>引数</title>
+   <para>
+    <variablelist>
+
+     <varlistentry>
+      <term><replaceable class="parameter">pcp_server</replaceable></term>
+      <listitem>
+       <para>
+<!--
+         The foreign server name for pcp server.
+-->
+pcpサーバの外部サーバ名
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+<!--
+      <term><option>Other arguments </option></term>
+-->
+      <term><option>他の引数</option></term>
+      <listitem>
+       <para>
+<!--
+        See <xref linkend="pcp-common-options">.
+-->
+<xref linkend="pcp-common-options">を参照ください。
+       </para>
+      </listitem>
+     </varlistentry>
+    </variablelist>
+   </para>
+ </refsect1>
+
+ <refsect1>
+<!--
+  <title>Example</title>
+-->
+  <title>使用例</title>
+   <para>
+<!--
+       Here is an example output:
+-->
+使用例です。
+       <programlisting>
+test=# SELECT * FROM pcp_node_count('localhost',11001,'t-ishii','t-ishii');
+ node_count 
+------------
+          2
+(1 row)
+       </programlisting>
+  </para>
+
+ </refsect1>
+
+</refentry>

diff --git a/doc.ja/src/sgml/ref/pgpool_adm_pcp_node_info.sgml b/doc.ja/src/sgml/ref/pgpool_adm_pcp_node_info.sgml
new file mode 100644 (file)
index 0000000..3711acb
--- /dev/null
+++ b/doc.ja/src/sgml/ref/pgpool_adm_pcp_node_info.sgml
@@ -0,0 +1,137 @@
+<!--
+doc/src/sgml/ref/pgpool_adm_pcp_node_info.sgml
+Pgpool-II documentation
+-->
+
+<refentry id="PGPOOL-ADM-PCP-NODE-INFO">
+ <indexterm zone="pgpool-adm-pcp-node-info">
+  <primary>pgpool_adm_pcp_node_info</primary>
+ </indexterm>
+
+ <refmeta>
+  <refentrytitle>pgpool_adm_pcp_node_info</refentrytitle>
+  <manvolnum>3</manvolnum>
+  <refmiscinfo>pgpool_adm extension</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+  <refname>pgpool_adm_pcp_node_info</refname>
+  <refpurpose>
+<!--
+       a function to display the information on the given node
+       ID
+-->
+指定ノードIDの情報を表示する関数
+  </refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+   <funcsynopsis>
+     <funcprototype>
+       <funcdef><function>pcp_node_info</function> returns record</funcdef>
+       <paramdef>integer <parameter>node_id</parameter></paramdef>
+       <paramdef>text <parameter>host</parameter></paramdef>
+       <paramdef>integer <parameter>port</parameter></paramdef>
+       <paramdef>text <parameter>username</parameter></paramdef>
+       <paramdef>text <parameter>password</parameter></paramdef>
+       <paramdef>out <parameter>status text</parameter></paramdef>
+       <paramdef>out <parameter>weight float4</parameter></paramdef>
+     </funcprototype>
+     
+     <funcprototype>
+       <funcdef><function>pcp_node_info</function> returns record</funcdef>
+       <paramdef>integer <parameter>node_id</parameter></paramdef>
+       <paramdef>text <parameter>pcp_server</parameter></paramdef>
+       <paramdef>out <parameter>status text</parameter></paramdef>
+       <paramdef>out <parameter>weight float4</parameter></paramdef>
+     </funcprototype>
+
+   </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id="R3-PCP-NODE-INFO-3">
+<!--
+  <title>Description</title>
+-->
+  <title>説明</title>
+  <para>
+<!--
+  <function>pcp_node_info</function>
+       displays the information on the given node ID.
+-->
+  <function>pcp_node_info</function>は指定されたノードIDの情報を表示します。
+  </para>
+ </refsect1>
+
+ <refsect1>
+<!--
+  <title>Arguments</title>
+-->
+  <title>引数</title>
+   <para>
+    <variablelist>
+
+     <varlistentry>
+      <term><replaceable class="parameter">node_id</replaceable></term>
+      <listitem>
+       <para>
+<!--
+        The index of backend node to get information of.
+-->
+情報を取得するバックエンドノード
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><replaceable class="parameter">pcp_server</replaceable></term>
+      <listitem>
+       <para>
+<!--
+         The foreign server name for pcp server.
+-->
+pcpサーバの外部サーバ名
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+<!--
+      <term><option>Other arguments </option></term>
+-->
+      <term><option>他の引数</option></term>
+      <listitem>
+       <para>
+<!--
+        See <xref linkend="pcp-common-options">.
+-->
+<xref linkend="pcp-common-options">を参照ください。
+       </para>
+      </listitem>
+     </varlistentry>
+    </variablelist>
+   </para>
+ </refsect1>
+
+ <refsect1>
+<!--
+  <title>Example</title>
+-->
+  <title>使用例</title>
+   <para>
+<!--
+       Here is an example output:
+-->
+使用例です。
+       <programlisting>
+test=# SELECT * FROM pcp_node_info(0,'',11001,'t-ishii','t-ishii');
+ host | port  |      status       | weight 
+------+-------+-------------------+--------
+ /tmp | 11002 | Connection in use |      0
+(1 row)
+    </programlisting>
+  </para>
+
+ </refsect1>
+
+</refentry>

diff --git a/doc.ja/src/sgml/ref/pgpool_adm_pcp_pool_status.sgml b/doc.ja/src/sgml/ref/pgpool_adm_pcp_pool_status.sgml
new file mode 100644 (file)
index 0000000..09ea15e
--- /dev/null
+++ b/doc.ja/src/sgml/ref/pgpool_adm_pcp_pool_status.sgml
@@ -0,0 +1,126 @@
+<!--
+doc/src/sgml/ref/pgpool_adm_pcp_pool_status.sgml
+Pgpool-II documentation
+-->
+
+<refentry id="PGPOOL-ADM-PCP-POOL-STATUS">
+ <indexterm zone="pgpool-adm-pcp-pool-status">
+  <primary>pgpool_adm_pcp_pool_status</primary>
+ </indexterm>
+
+ <refmeta>
+  <refentrytitle>pgpool_adm_pcp_pool_status</refentrytitle>
+  <manvolnum>3</manvolnum>
+  <refmiscinfo>pgpool_adm extension</refmiscinfo>
+ </refmeta>
+
+ <refnamediv>
+  <refname>pgpool_adm_pcp_pool_status</refname>
+  <refpurpose>
+<!--
+    a function to retrieves parameters in pgpool.conf.
+-->
+pgpool.confのパラメータを取得する関数
+  </refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+   <funcsynopsis>
+     <funcprototype>
+       <funcdef><function>pcp_pool_status</function> returns record</funcdef>
+       <paramdef>text <parameter>host</parameter></paramdef>
+       <paramdef>integer <parameter>port</parameter></paramdef>
+       <paramdef>text <parameter>username</parameter></paramdef>
+       <paramdef>text <parameter>password</parameter></paramdef>
+       <paramdef>out <parameter>item text</parameter></paramdef>
+       <paramdef>out <parameter>value text</parameter></paramdef>
+       <paramdef>out <parameter>description text</parameter></paramdef>
+     </funcprototype>
+
+     <funcprototype>
+       <funcdef><function>pcp_pool_status</function> returns record</funcdef>
+       <paramdef>text <parameter>pcp_server</parameter></paramdef>
+       <paramdef>out <parameter>item text</parameter></paramdef>
+       <paramdef>out <parameter>value text</parameter></paramdef>
+       <paramdef>out <parameter>description text</parameter></paramdef>
+     </funcprototype>
+
+   </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1 id="R3-PCP-POOL-STATUS-3">
+  <title>Description</title>
+  <para>
+<!--
+    <function>pcp_pool_status</function> retrieves parameters in
+      pgpool.conf.
+-->
+<function>pcp_pool_status</function>はpgpool.confのパラメータを取得します。
+  </para>
+ </refsect1>
+
+ <refsect1>
+<!--
+  <title>Arguments</title>
+-->
+  <title>引数</title>
+   <para>
+    <variablelist>
+
+     <varlistentry>
+      <term><replaceable class="parameter">pcp_server</replaceable></term>
+      <listitem>
+       <para>
+<!--
+         The foreign server name for pcp server.
+-->
+pcpサーバの外部サーバ名
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+<!--
+      <term><option>Other arguments </option></term>
+-->
+      <term><option>他の引数</option></term>
+      <listitem>
+       <para>
+<!--
+        See <xref linkend="pcp-common-options">.
+-->
+<xref linkend="pcp-common-options">を参照ください。
+       </para>
+      </listitem>
+     </varlistentry>
+    </variablelist>
+   </para>
+ </refsect1>
+
+ <refsect1>
+<!--
+  <title>Example</title>
+-->
+  <title>使用例</title>
+   <para>
+<!--
+       Here is an example output:
+-->
+使用例です。
+       <programlisting>
+ test=# SELECT * FROM pcp_pool_status('localhost',11001,'t-ishii','t-ishii') WHERE item ~ 'backend.*0';
+          item           |                     value                      |          description          
+-------------------------+------------------------------------------------+-------------------------------
+ backend_hostname0       | /tmp                                           | backend #0 hostname
+ backend_port0           | 11002                                          | backend #0 port number
+ backend_weight0         | 0.500000                                       | weight of backend #0
+ backend_data_directory0 | /home/t-ishii/work/pgpool-II/current/aaa/data0 | data directory for backend #0
+ backend_status0         | 2                                              | status of backend #0
+ backend_flag0           | ALLOW_TO_FAILOVER                              | backend #0 flag
+(6 rows)
+    </programlisting>
+  </para>
+
+ </refsect1>
+
+</refentry>

diff --git a/doc.ja/src/sgml/reference.sgml b/doc.ja/src/sgml/reference.sgml
index 977c0ad5d8e4dece470da0691c75b02e99774630..4d89adaebf1b8b7416b3f63e30baeeceaaa96257 100644 (file)
--- a/doc.ja/src/sgml/reference.sgml
+++ b/doc.ja/src/sgml/reference.sgml
@@ -217,5 +217,134 @@ hostname:port:username:password
    &showPoolVersion
    &showPoolCache
 
- </reference>
+   </reference>
+   <reference id="pgpool-adm">
+<!--
+    <title>pgpool_adm extension</title>
+-->
+    <title>pgpool_admエクステンション</title>
+    <partintro>
+      <para>
+<!--
+       <command>pgpool_adm</command> is a set of extensions to allow
+       SQL access to <xref linkend="pcp-commands"> (actually, pcp
+         libraries). It uses foreign data wrapper as shown in the
+         diagram below.
+-->
+<command>pgpool_adm</command>は、<xref linkend="pcp-commands"> (実際には, pcp
+ライブラリ)にアクセスできるようにするための一連のエクステンションです。
+      </para>
+      <para>
+       <figure>
+<!--
+         <title>How <command>pgpool_adm</command> works</title>
+-->
+         <title><command>pgpool_adm</command>が動く仕組み</title>
+         <mediaobject>
+           <imageobject>
+             <imagedata fileref="pgpool_adm.gif">
+           </imageobject>
+         </mediaobject>
+       </figure>
+      </para>
+
+      <para>
+<!--
+       It is possible to call the functions from either via pgpool-II
+       (1) or via <productname>PostgreSQL</productname> (2).  In case
+       (1), <productname>Pgpool-II</productname> accepts query from
+       user (1), then forward
+       to <productname>PostgreSQL</productname> (3).
+       <productname>PostgreSQL</productname> connects
+       to <productname>Pgpool-II</productname> (5)
+       and <productname>Pgpool-II</productname> reply back
+       to <productname>PostgreSQL</productname> with the result
+       (3). <productname>PostgreSQL</productname> returns the result
+       to <productname>Pgpool-II</productname> (5)
+       and <productname>Pgpool-II</productname> fowards the data to
+       the user (6).
+-->
+<productname>Pgpool-II</productname>経由でも(1)、あるいは直接<productname>PostgreSQL</productname>に対しても(2)、関数を呼び出すことができます。
+(1)の場合には、<productname>Pgpool-II</productname>はユーザからクエリを受け付け(1)、<productname>PostgreSQL</productname>に転送します(3)。
+<productname>PostgreSQL</productname>は、<productname>Pgpool-II</productname>に接続し(5)、<productname>Pgpool-II</productname>は<productname>PostgreSQL</productname>に(3)の結果を返します。
+<productname>PostgreSQL</productname>は<productname>Pgpool-II</productname>に結果を返し(5)、<productname>Pgpool-II</productname>はそのデータをユーザに転送します(6)。
+      </para>
+      <para>
+<!--
+       In case (2), <productname>PostgreSQL</productname> accepts query from user (2).
+       <productname>PostgreSQL</productname> connects
+       to <productname>Pgpool-II</productname> (5)
+       and <productname>Pgpool-II</productname> reply back
+       to <productname>PostgreSQL</productname> with the result (3).
+       <productname>PostgreSQL</productname> replies back the data to
+       the user (6).
+-->
+(2)の場合には、<productname>PostgreSQL</productname>がクエリをユーザから受け付けます(2)。
+<productname>PostgreSQL</productname>は<productname>Pgpool-II</productname>に接続し(5)、<productname>Pgpool-II</productname>は<productname>PostgreSQL</productname>に(3)の結果を返します。
+<productname>PostgreSQL</productname>はそのデータをユーザに返します(6)。
+      </para>
+      <para>
+<!--
+       There are two forms to call pgpool_adm functions: first form
+       accepts <productname>Pgpool-II</productname> host name (or IP
+       address), pcp port number, pcp user name, its password and
+       another parameters.
+-->
+pgpool_adm関数の呼び出し形式は2種類あります。
+最初の形式は<productname>Pgpool-II</productname>のホスト名(またはIPアドレス)、pcpポート番号、pcpユーザ名、パスワード、それ以外のパラメータです。
+      </para>
+      <para>
+<!--
+       In the second form, <productname>Pgpool-II</productname>
+       server name is required.  The server name must be already
+       defined using "CREATE FOREIGN SERVER" command
+       of <productname>PostgreSQL</productname>.  The pcp port number
+       is hard coded as 9898, the pcp user name is assumes to be same
+       as caller's <productname>PostgreSQL</productname> user name.
+       password is extraced from $HOME/.pcppass.
+-->
+2番目の形式では、<productname>Pgpool-II</productname>サーバ名が必要になります。
+サーバ名は<productname>PostgreSQL</productname>の"CREATE FOREIGN SERVER"コマンドで定義済みでなければなりません。
+pcpポート番号は9898に固定されています。
+pcpユーザ名は、呼び出し元の<productname>PostgreSQL</productname>ユーザ名と同じであると見なされます。
+パスワードは$HOME/.pcppassから取得します。
+      </para>
+
+      <sect1 id="installing-pgpool-adm">
+<!--
+       <title>Installing pgpool_adm</title>
+-->
+       <title>pgpool_admのインストール</title>
+       <para>
+<!--
+         pgpool_adm is an extension and should be installed on all
+         PostgreSQL servers.
+-->
+pgpool_admはエクステンションであり、すべてのPostgreSQLサーバにインストールする必要があります。
+         <programlisting>
+$ cd src/sql/pgpool_adm
+$ make
+$ make install
+         </programlisting>
+<!--
+         Then issue following SQL command for every database you want to access.
+-->
+次のSQLコマンドをアクセスしたいすべてのデータベースに発行します。
+         <programlisting>
+$ psql ...
+$ CREATE EXTENSION pgpool_adm
+         </programlisting>
+       </para>
+      </sect1>
+      
+    </partintro>
+
+    &pgpoolAdmPcpNodeInfo
+    &pgpoolAdmPcpPoolStatus
+    &pgpoolAdmPcpNodeCount
+    &pgpoolAdmPcpAttachNode
+    &pgpoolAdmPcpDetachNode
+
+  </reference>
+
 </part>

diff --git a/doc/src/sgml/ref/pgpool_adm_pcp_detach_node.sgml b/doc/src/sgml/ref/pgpool_adm_pcp_detach_node.sgml
index 8e4ed42e0489b4573005b5d6fc7923e732411bb1..ceb7d10eedc25c06a4f8678ce41c7adc4c4ded17 100644 (file)
--- a/doc/src/sgml/ref/pgpool_adm_pcp_detach_node.sgml
+++ b/doc/src/sgml/ref/pgpool_adm_pcp_detach_node.sgml
@@ -48,7 +48,7 @@ Pgpool-II documentation
   <title>Description</title>
   <para>
     <function>pcp_detach_node</function> detaches a node
-    to <productname>Pgpool-II</productname>.
+    from <productname>Pgpool-II</productname>.
   </para>
  </refsect1>
 

diff --git a/doc/src/sgml/ref/pgpool_adm_pcp_node_count.sgml b/doc/src/sgml/ref/pgpool_adm_pcp_node_count.sgml
index 16bf7d1a7c685ac4b197a8e411f42b267294e149..d64cdcc0327e0a5e80a844b68eaea580f37e1cea 100644 (file)
--- a/doc/src/sgml/ref/pgpool_adm_pcp_node_count.sgml
+++ b/doc/src/sgml/ref/pgpool_adm_pcp_node_count.sgml
@@ -17,7 +17,8 @@ Pgpool-II documentation
  <refnamediv>
   <refname>pgpool_adm_pcp_node_count</refname>
   <refpurpose>
-       a function to retrieves parameters in pgpool.conf.</refpurpose>
+    a function to retrieves number of backend nodes.
+  </refpurpose>
  </refnamediv>
 
  <refsynopsisdiv>