Add show pool_nodes, show pool_processes and show pool_status
authorTatsuo Ishii <ishii@postgresql.org>
Mon, 17 Oct 2016 04:45:05 +0000 (13:45 +0900)
committerTatsuo Ishii <ishii@postgresql.org>
Mon, 17 Oct 2016 04:45:05 +0000 (13:45 +0900)
reference manuals.

doc/src/sgml/ref/allfiles.sgml
doc/src/sgml/ref/show_pool_nodes.sgml [new file with mode: 0644]
doc/src/sgml/ref/show_pool_processes.sgml [new file with mode: 0644]
doc/src/sgml/ref/show_pool_status.sgml [new file with mode: 0644]
doc/src/sgml/reference.sgml

index 4e9a463c93ef99a659e82509499e3e840b541e4b..5dea7a02bd1a67556e0f3c6d97a5873f6a64d1db 100644 (file)
@@ -5,9 +5,6 @@ Complete list of usable sgml source files in this directory.
 -->
 
 <!ENTITY pcpCommonOptions    SYSTEM "pcp_common_options.sgml">
-<!ENTITY pgpoolShow          SYSTEM "pgpool_show.sgml">
-<!ENTITY pgpoolReset         SYSTEM "pgpool_reset.sgml">
-<!ENTITY pgpoolSet           SYSTEM "pgpool_set.sgml">
 <!ENTITY pcpNodeCount        SYSTEM "pcp_node_count.sgml">
 <!ENTITY pcpNodeInfo         SYSTEM "pcp_node_info.sgml">
 <!ENTITY pcpWatchdogInfo     SYSTEM "pcp_watchdog_info.sgml">
@@ -22,3 +19,9 @@ Complete list of usable sgml source files in this directory.
 <!ENTITY pgMd5               SYSTEM "pg_md5.sgml">
 <!ENTITY pgpoolSetup         SYSTEM "pgpool_setup.sgml">
 <!ENTITY watchdoglSetup      SYSTEM "watchdog_setup.sgml">
+<!ENTITY pgpoolShow          SYSTEM "pgpool_show.sgml">
+<!ENTITY pgpoolReset         SYSTEM "pgpool_reset.sgml">
+<!ENTITY pgpoolSet           SYSTEM "pgpool_set.sgml">
+<!ENTITY showPoolStatus      SYSTEM "show_pool_status.sgml">
+<!ENTITY showPoolNodes       SYSTEM "show_pool_nodes.sgml">
+<!ENTITY showPoolProcesses   SYSTEM "show_pool_processes.sgml">
diff --git a/doc/src/sgml/ref/show_pool_nodes.sgml b/doc/src/sgml/ref/show_pool_nodes.sgml
new file mode 100644 (file)
index 0000000..5da24f8
--- /dev/null
@@ -0,0 +1,63 @@
+<!--
+    doc/src/sgml/ref/show_pool_nodes.sgml
+    Pgpool-II documentation
+  -->
+
+<refentry id="SQL-SHOW-POOL-NODES">
+  <indexterm zone="sql-show-pool-nodes">
+    <primary>SHOW</primary>
+  </indexterm>
+
+  <refmeta>
+    <refentrytitle>SHOW POOL NODES</refentrytitle>
+    <manvolnum>1</manvolnum>
+    <refmiscinfo>SQL - Language Statements</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>SHOW POOL_NODES</refname>
+    <refpurpose>
+      sends back a list of all configured nodes.
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <synopsis>
+      SHOW POOL_NODES
+    </synopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para>
+      <command>SHOW POOL_NODES</command> displays the node id, the
+      hostname, the port, the status, the weight (only meaningful if
+      you use the load balancing mode), the role, the SELECT query
+      counts issued to each backend, whether each node is the load
+      bakance node or not, and the replication delay (only if in
+      streaming replication mode). The possible values in the status
+      column are explained in the <xref linkend="pcp-node-info">
+      reference. If the hostname is something like "/tmp", that means
+      <productname>Pgpool-II</productname> is connecting to backend by
+      using UNIX domain sockets. The SELECT count does not include
+      internal queries used
+      by <productname>Pgoool-II</productname>. Also the counters are
+      reset to zero upon starting up of pgpool-II.  displays the
+      current value of
+      <productname>Pgpool-II</productname> configuration parameters.
+    </para>
+    <para>
+      Here is an example session:
+<programlisting>
+test=# show pool_nodes;
+ node_id | hostname | port  | status | lb_weight |  role   | select_cnt | load_balance_node | replication_delay 
+---------+----------+-------+--------+-----------+---------+------------+-------------------+-------------------
+ 0       | /tmp     | 11002 | up     | 0.500000  | primary | 0          | false             | 0
+ 1       | /tmp     | 11003 | up     | 0.500000  | standby | 0          | true              | 0
+(2 rows)
+</programlisting>
+    </para>
+  </refsect1>
+
+</refentry>
diff --git a/doc/src/sgml/ref/show_pool_processes.sgml b/doc/src/sgml/ref/show_pool_processes.sgml
new file mode 100644 (file)
index 0000000..47bb97c
--- /dev/null
@@ -0,0 +1,125 @@
+<!--
+    doc/src/sgml/ref/show_pool_processes.sgml
+    Pgpool-II documentation
+  -->
+
+<refentry id="SQL-SHOW-POOL-PROCESSES">
+  <indexterm zone="sql-show-pool-processes">
+    <primary>SHOW</primary>
+  </indexterm>
+
+  <refmeta>
+    <refentrytitle>SHOW POOL PROCESSES</refentrytitle>
+    <manvolnum>1</manvolnum>
+    <refmiscinfo>SQL - Language Statements</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>SHOW POOL_PROCESSES</refname>
+    <refpurpose>
+      sends back a list of all pgPool-II processes waiting for
+      connections and dealing with a connection.
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <synopsis>
+      SHOW POOL_PROCESSES
+    </synopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para>
+      <command>SHOW pool_processes</command> sends back a list of all
+      <productname>Pgpool-II</productname> processes waiting for
+      connections and dealing with a connection.
+    </para>
+    <para>
+      It has 6 columns:
+      <itemizedlist>
+       <listitem>
+         <para>
+           <literal>pool_pid</literal> is the PID of the
+           displayed <productname>Pgpool-II</productname> process.
+         </para>
+       </listitem>
+       <listitem>
+         <para>
+           <literal>start_time</literal> is the timestamp of when
+           this process was launched.
+         </para>
+       </listitem>
+       <listitem>
+         <para>
+           <literal>database</literal> is the database name of the
+           currently active backend for this process.
+         </para>
+       </listitem>
+       <listitem>
+         <para>
+           <literal>username</literal> is the user name used in the
+           connection of the currently active backend for this
+           process.
+         </para>
+       </listitem>
+       <listitem>
+         <para>
+           <literal>create_time</literal> is the creation time and
+           date of the connection.
+         </para>
+       </listitem>
+       <listitem>
+         <para>
+           <literal>pool_counter</literal> counts the number of times
+           this pool of connections (process) has been used by
+           clients.
+           </para>
+         </listitem>
+       </itemizedlist>
+    </para>
+    <para>
+      Here is an example session:
+<programlisting>
+test=# show pool_processes;
+ pool_pid |     start_time      | database | username |     create_time     | pool_counter 
+----------+---------------------+----------+----------+---------------------+--------------
+ 19696    | 2016-10-17 13:24:17 | postgres | t-ishii  | 2016-10-17 13:35:12 | 1
+ 19697    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19698    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19699    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19700    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19701    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19702    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19703    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19704    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19705    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19706    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19707    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19708    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19709    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19710    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19711    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19712    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19713    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19714    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19715    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19716    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19717    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19718    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19719    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19720    | 2016-10-17 13:24:17 |          |          |                     | 
+ 20024    | 2016-10-17 13:33:46 |          |          |                     | 
+ 19722    | 2016-10-17 13:24:17 | test     | t-ishii  | 2016-10-17 13:34:42 | 1
+ 19723    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19724    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19725    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19726    | 2016-10-17 13:24:17 |          |          |                     | 
+ 19727    | 2016-10-17 13:24:17 |          |          |                     | 
+(32 rows)
+</programlisting>
+    </para>
+  </refsect1>
+
+</refentry>
diff --git a/doc/src/sgml/ref/show_pool_status.sgml b/doc/src/sgml/ref/show_pool_status.sgml
new file mode 100644 (file)
index 0000000..a4f6e1a
--- /dev/null
@@ -0,0 +1,54 @@
+<!--
+    doc/src/sgml/ref/show_pool_status.sgml
+    Pgpool-II documentation
+  -->
+
+<refentry id="SQL-SHOW-PGPOOL-STATUS">
+  <indexterm zone="sql-show-pgpool-status">
+    <primary>SHOW</primary>
+  </indexterm>
+
+  <refmeta>
+    <refentrytitle>SHOW PGPOOL STATUS</refentrytitle>
+    <manvolnum>1</manvolnum>
+    <refmiscinfo>SQL - Language Statements</refmiscinfo>
+  </refmeta>
+
+  <refnamediv>
+    <refname>SHOW PGPOOL STATUS</refname>
+    <refpurpose>
+      sends back the list of configuration parameters with their name,
+      value, and description.
+    </refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <synopsis>
+      SHOW POOL_STATUS
+    </synopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para>
+      <command>SHOW POOL_STATUS</command> displays the current value of
+      <productname>Pgpool-II</productname> configuration parameters.
+    </para>
+    <para>
+      This command is similar to the
+      <xref linkend="SQL-PGPOOL-SHOW"> command, but this is the older
+       version of it.  It is recommended to
+       use <xref linkend="SQL-PGPOOL-SHOW"> instead.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+
+    <simplelist type="inline">
+      <member><xref linkend="SQL-PGPOOL-SHOW"></member>
+    </simplelist>
+  </refsect1>
+
+</refentry>
index 18cb9d76e1e251c3cdec8e2d0abf50d3aecc2bf1..006f1f93bb387b50b6ad1fa8f065e32a1c9937cf 100644 (file)
    &pgpoolShow
    &pgpoolSet
    &pgpoolReset
+   &showPoolStatus
+   &showPoolNodes
+   &showPoolProcesses
 
  </reference>
 </part>