Doc: enhance pgproto.
authorTatsuo Ishii <ishii@sraoss.co.jp>
Wed, 12 Jan 2022 05:07:05 +0000 (14:07 +0900)
committerTatsuo Ishii <ishii@sraoss.co.jp>
Wed, 12 Jan 2022 05:07:05 +0000 (14:07 +0900)
Add documents for the previous commit.

doc.ja/src/sgml/ref/pgproto.sgml
doc/src/sgml/ref/pgproto.sgml

index 4a8d19b387aa164f772e1bd27345503efb5394bb..aa4d043e1e99a987d9649580d8ebefbf2a749858 100644 (file)
@@ -195,18 +195,24 @@ Pgpool-II documentation
   </para>
   <para>
    <!--
-   Exceptions are 'Y' and 'y'. 'Y' reads messages from backend
+   Exceptions are 'Y' , 'y' and 'z'. 'Y' reads messages from backend
    until 'Ready for query' is received.
    'y' reads messages from backend while messages are coming from backend then stops
    if messages are not available for 1 second.
    'Y' is used for waiting for reply of 'Q' (simple query) or after 'S' (sync) in extended queries.
    'y' can be used for receiving messages after 'H' (flush).
+   'z' reads 1 messages from backend. If no message arrives within 1 second, 'z' stops.
+   If you want to read multiple messages, you can use repeat 'z' for the message count.
+   'z' can be useful for 'H' message test when you already know how
+   many reply messages will come.
    -->
-   'Y'と'y'は例外です。
+   'Y'と'z'と'y'は例外です。
    'Y'は、Ready for queryが受信されるまで、バックエンドからメッセージを読み取ります。
    'y'は、バックエンドからメッセージを受信している間はメッセージを読み取り、1秒間メッセージを受信しなかった場合停止します。
    'Y'は、拡張クエリのSync ('S')、簡易問い合わせ ('Q')の応答を待つために使用できます。
-   'y'は、Flush ('H')後にメッセージを受診するために使用できます。
+   'y'は、Flush ('H')後にメッセージを受信するために使用できます。
+   'z'は、バックエンドから1つメッセージを読みます。1秒間メッセージを受信しなかった場合停止します。
+   'z'は、事前にいくつメッセージが届くかわかっている場合に'H'のテストのために利用することができます。
   </para>
   <para>
    <!--
index db81f3aee59506409a2d62b1eaf3268d13ba358e..3f02cb6f29494a61a4ae4cf459b043421a00f63b 100644 (file)
@@ -142,12 +142,16 @@ Pgpool-II documentation
    indicates the message kind specified in the PostgreSQL frontend/backend protocol.
   </para>
   <para>
-   Exceptions are 'Y' and 'y'. 'Y' reads messages from backend
+   Exceptions are 'Y' , 'y' and 'z'. 'Y' reads messages from backend
    until 'Ready for query' is received.
    'y' reads messages from backend while messages are coming from backend then stops
    if messages are not available for 1 second.
    'Y' is used for waiting for reply of 'Q' (simple query) or after 'S' (sync) in extended queries.
    'y' can be used for receiving messages after 'H' (flush).
+   'z' reads 1 messages from backend. If no message arrives within 1 second, 'z' stops.
+   If you want to read multiple messages, you can use repeat 'z' for the message count.
+   'z' can be useful for 'H' message test when you already know how
+   many reply messages will come.
   </para>
   <para>
    If you want to include a " (double quotation) in a string data type,