pgpool2.git / summary / log / commit / refs
commit ea1998b7350de6882bea25fc3634c4f7673adbde
Author: Takuma Hoshiai <hoshiai@sraoss.co.jp>
Date: Wed Jan 23 06:38:40 2019 +0000
Doc: update 'Preface' chapter for version 4.1.
reviewd by Tatsuo Ishii and Bo Peng.
doc.ja/src/sgml/intro.sgml | 47 ++++++++++++++++++++++++++++---
doc.ja/src/sgml/restrictions.sgml | 59 +++++++++++++++++++++++++++++++++++----
doc/src/sgml/intro.sgml | 32 +++++++++++++++++++--
doc/src/sgml/restrictions.sgml | 37 ++++++++++++++++++++++--
4 files changed, 162 insertions(+), 13 deletions(-)
diff --git a/doc.ja/src/sgml/intro.sgml b/doc.ja/src/sgml/intro.sgml
index ac72eeb71..092e57448 100644
--- a/doc.ja/src/sgml/intro.sgml
+++ b/doc.ja/src/sgml/intro.sgml
@@ -61,7 +61,7 @@
<xref linkend="examples"> explains several configuration examples
so that users can choose the starting point of their actual systems.
-->
-<xref linkend="examples">では、実際のシステムで使う際のスタートポイントとしてユーザが選択できるように。何種類かの構成例を説明しています。
+<xref linkend="examples">では、ユーザが実際のシステムで使う際の起点として選択できるように何種類かの構成例を説明しています。
</para>
</listitem>
@@ -128,11 +128,11 @@
<productname>Pgpool-II</productname> maintains established
connections to the <productname>PostgreSQL</productname>
servers, and reuses them whenever a new connection with the
- same properties (i.e. user name, database, protocol version)
+ same properties (i.e. user name, database, protocol version, and other connection parameters if any)
comes in. It reduces the connection overhead, and improves
system's overall throughput.
-->
-<productname>Pgpool-II</productname>は、<productname>PostgreSQL</productname>サーバへの確立された接続を維持し、プロパティ（つまりユーザ名、データベース、プロトコルバージョン）が同じ新規のコネクションが到着する度に再利用します。
+<productname>Pgpool-II</productname>は、<productname>PostgreSQL</productname>サーバへの確立された接続を維持し、プロパティ（つまりユーザ名、データベース、プロトコルバージョン、他に指定されていれば接続パラメータも）が同じ新規のコネクションが到着する度に再利用します。
コネクションオーバヘッドを軽減することによって、システム全体のスループットを改善します。
</para>
</listitem>
@@ -222,16 +222,55 @@ SELECTクエリをサーバに分散させ、システム全体のスループ
performance. <productname>Pgpool-II</productname> also has a
limit on the maximum number of connections, but extra
connections will be queued instead of returning an error
- immediately.
+ immediately. However, you can configure to return an error
+ when the connection limit is exceeded (4.1 or later).
-->
<productname>PostgreSQL</productname>への最大同時接続数には制限があり、その制限に達すると新しいコネクションは拒否されます。
最大接続数を大きくすると、リソースの消費が増え、システム全体の性能に悪影響があります。
<productname>Pgpool-II</productname>にも最大接続数の制限があります。
しかし、制限を超えた接続要求はすぐにエラーが返るのではなく、待ち行列に入ります。
+ただし、制限を超えた接続要求に対してエラーを返すように設定することも可能です(4.1 以降)。
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>Watchdog</term>
+ <listitem>
+ <para>
+<!--
+ Watchdog can coordinate multiple <productname>Pgpool-II</productname>,
+ create a robust cluster system and avoid the single point of failure or split brain.
+ Watchdog can perform lifecheck against other <productname>pgpool-II</productname> nodes,
+ to detect a fault of <productname>Pgpoll-II</productname>.
+ If active <productname>Pgpool-II</productname> goes down, standby
+ <productname>Pgpool-II</productname> can be promoted to active, and take over Virtual IP.
+-->
+Watchdogは、複数の<productname>Pgpool-II</productname>を協調させて動作させることにより、単一障害点やスプリットブレインの起きない堅牢なクラスタを運用することが可能です。
+他の<productname>Pgpool-II</productname>の死活監視を行い、障害を検出することができます。
+稼働系の<productname>Pgpool-II</productname>がダウンしても、待機系の<productname>Pgpool-II</productname>が稼動系に昇格し、仮想IPを引き継ぐことができます。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>インメモリキャッシュ</term>
+ <listitem>
+ <para>
+<!--
+ In memory query cache allows to save a pair of SELECT statement and its result.
+ If an identical SELECTs comes in, <productname>Pgpool-II</productname> returns the
+ value from cache. Since no SQL parsing nor access to <productname>PostgreSQL</productname>
+ are involved, using in memory cache is extremely fast. On the other hand, it might
+ be slower than the normal path in some cases, because it adds some overhead of storing cache data.
+-->
+SELECT文とその検索結果をキャッシュに保存できます。同じSELECT文が発行された場合、<productname>Pgpool-II</productname>はキャッシュから結果を返します。
+SQLの解析も<productname>PostgreSQL</productname>へのアクセスも行われないため、インメモリキャッシュの利用は非常に高速です。
+反面、キャッシュを保存するオーバヘッドが生じるので、通常の方法より遅くなる場合もあります。
+ </para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</para>
diff --git a/doc.ja/src/sgml/restrictions.sgml b/doc.ja/src/sgml/restrictions.sgml
index c8f4ef2d4..f0ac7e162 100644
--- a/doc.ja/src/sgml/restrictions.sgml
+++ b/doc.ja/src/sgml/restrictions.sgml
@@ -50,17 +50,18 @@
<listitem>
<para>
<!--
- In the replication mode or master/slave mode, trust, clear
- text password, and pam methods are supported. md5 in also
- supported since <productname>Pgpool-II</productname> 3.0. md5
+ In the replication mode or master/slave mode, trust and pam methods are supported. md5 is also
+ supported since <productname>Pgpool-II</productname> 3.0. md5
is supported by using a authencitaion file <filename>pool_passwd</filename>.
+ scram-sha-256, cert, and clear text password is also supported since
+ <productname>Pgpool-II</productname> 4.0.
<filename>pool_passwd</filename> is default name of the
authentication file. Here are the
steps to enable md5 authentication:
-->
-レプリケーションモードまたマスタ/スレーブモード時にはtrust、reject、clear text password、pam認証方式が利用できます。
-crypt認証は利用できません。
+レプリケーションモードまたマスタ/スレーブモード時にはtrust、reject、pam認証方式が利用できます。
<productname>Pgpool-II</productname> 3.0以降では、<filename>pool_passwd</filename>というファイルを使ってmd5認証も使えます。
+<productname>Pgpool-II</productname> 4.0以降では、scram-sha-256、cert、clear text password認証も使えます。
<filename>pool_passwd</filename>はデフォルトの認証ファイル名です。
md5認証を有効にする手順を示します。
</para>
@@ -369,6 +370,54 @@ INSERT INTO rel1(c1) SELECT 1
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>マルチバイト文字</term>
+ <listitem>
+ <para>
+<!--
+ <productname>Pgpool-II</productname> does not perform encoding converion between client and
+ <productname>PostgreSQL</productname> for multi-byte characters.
+ The encoding for the client and backends must be the same.
+-->
+現在の実装では、クライアントと<productname>PostgreSQL</productname>の間でマルチバイト文字の変換処理を行いません。
+クライアントエンコーディング、バックエンドノードのサーバエンコーディングを一致させるようにしてください。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>マルチステートメント</term>
+ <listitem>
+ <para>
+<!--
+ <productname>Pgpool-II</productname> cannot process multi-statement queries.
+ However, when <productname>Pgpool-II</productname> is connected by <command>psql</command>, It is no problem.
+ <command>psql</command> parse multi-statement, send a statement one by one.
+-->
+マルチステートメント（';'で区切って複数の文をまとめたSQL）を<productname>Pgpool-II</productname>が正しく処理することができません。
+必ず文を分けて送信してください。
+なお、<command>psql</command>を使って<productname>Pgpool-II</productname>に接続した場合は、<command>psql</command>内部でマルチステートメントを分解し、1つずつ送信するので、実際には問題になりません。
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>libpq</term>
+ <listitem>
+ <para>
+<!--
+ libpq is linked while building <productname>Pgpool-II</productname>.
+ libpq version must be 3.0 or later. Building <productname>Pgpool-II</productname> with libpq version 2.0 will fail.
+-->
+<productname>pgpool-II</productname> では libpq をリンクします。
+libpq のバージョンは 2.0 の場合、configureに失敗します。
+必ず libpq 3.0 以降(<productname>PostgreSQL</productname> 7.4以降)をリンクするようにしてください。
+マルチステートメント（';'で区切って複数の文をまとめたSQL）を<productname>Pgpool-II</productname>が正しく処理することができません。
+必ず文を分けて送信してください。
+ </para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</para>
</sect1>
diff --git a/doc/src/sgml/intro.sgml b/doc/src/sgml/intro.sgml
index 3b9bfc6fb..9a4916c36 100644
--- a/doc/src/sgml/intro.sgml
+++ b/doc/src/sgml/intro.sgml
@@ -88,7 +88,7 @@
<productname>Pgpool-II</productname> maintains established
connections to the <productname>PostgreSQL</productname>
servers, and reuses them whenever a new connection with the
- same properties (i.e. user name, database, protocol version)
+ same properties (i.e. user name, database, protocol version, and other connection parameters if any)
comes in. It reduces the connection overhead, and improves
system's overall throughput.
</para>
@@ -157,11 +157,39 @@
performance. <productname>Pgpool-II</productname> also has a
limit on the maximum number of connections, but extra
connections will be queued instead of returning an error
- immediately.
+ immediately. However, you can configure to return an error
+ when the connection limit is exceeded (4.1 or later).
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>Watchdog</term>
+ <listitem>
+ <para>
+ Watchdog can coordinate multiple <productname>Pgpool-II</productname>,
+ create a robust cluster system and avoid the single point of failure or split brain.
+ Watchdog can perform lifecheck against other <productname>pgpool-II</productname> nodes,
+ to detect a fault of <productname>Pgpoll-II</productname>.
+ If active <productname>Pgpool-II</productname> goes down, standby
+ <productname>Pgpool-II</productname> can be promoted to active, and take over Virtual IP.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>In Memory Query Cache</term>
+ <listitem>
+ <para>
+ In memory query cache allows to save a pair of SELECT statement and its result.
+ If an identical SELECTs comes in, <productname>Pgpool-II</productname> returns the
+ value from cache. Since no SQL parsing nor access to <productname>PostgreSQL</productname>
+ are involved, using in memory cache is extremely fast. On the other hand, it might
+ be slower than the normal path in some cases, because it adds some overhead of storing cache data.
+ </para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</para>
diff --git a/doc/src/sgml/restrictions.sgml b/doc/src/sgml/restrictions.sgml
index 7bcb29641..e4abf54cd 100644
--- a/doc/src/sgml/restrictions.sgml
+++ b/doc/src/sgml/restrictions.sgml
@@ -29,10 +29,11 @@
<term>Authentication/Access Controls</term>
<listitem>
<para>
- In the replication mode or master/slave mode, trust, clear
- text password, and pam methods are supported. md5 in also
+ In the replication mode or master/slave mode, trust and pam methods are supported. md5 is also
supported since <productname>Pgpool-II</productname> 3.0. md5
is supported by using a authencitaion file <filename>pool_passwd</filename>.
+ scram-sha-256, cert, and clear text password is also supported since
+ <productname>Pgpool-II</productname> 4.0.
<filename>pool_passwd</filename> is default name of the
authentication file. Here are the
steps to enable md5 authentication:
@@ -237,6 +238,38 @@ INSERT INTO rel1(c1) SELECT 1
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>Multi-byte Characters</term>
+ <listitem>
+ <para>
+ <productname>Pgpool-II</productname> does not perform encoding converion between client and
+ <productname>PostgreSQL</productname> for multi-byte characters.
+ The encoding for the client and backends must be the same.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Multi-statement Query</term>
+ <listitem>
+ <para>
+ <productname>Pgpool-II</productname> cannot process multi-statement queries.
+ However, when <productname>Pgpool-II</productname> is connected by <command>psql</command>, It is no problem.
+ <command>psql</command> parse multi-statement, send a statement one by one.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>libpq</term>
+ <listitem>
+ <para>
+ libpq is linked while building <productname>Pgpool-II</productname>.
+ libpq version must be 3.0 or later. Building <productname>Pgpool-II</productname> with libpq version 2.0 will fail.
+ </para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</para>
</sect1>
[parent: eec6067ec599]