diff options
| author | Taiki Koshino | 2025-07-15 00:16:37 +0000 |
|---|---|---|
| committer | Taiki Koshino | 2025-07-15 00:26:14 +0000 |
| commit | 2a236be3e8ae2aa6aa154664529a10a2c7a524ff (patch) | |
| tree | 63e4ba28be520706b27cb5ee7d704adbe97b702b /doc/src | |
| parent | 787e5f27c34a6865812db4adfc8bc5a1b12d13da (diff) | |
Doc: fix documentation for enum parameters reported as strings
Fix documentations for 6 parameters.
Japanese docs too.
"log_standby_delay"
"log_backend_messages"
"wd_lifecheck_method"
"memqcache_method"
"disable_load_balance_on_write"
"backend_clustering_mode"
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/connection-pooling.sgml | 2 | ||||
| -rw-r--r-- | doc/src/sgml/connection-settings.sgml | 24 | ||||
| -rw-r--r-- | doc/src/sgml/example-Aurora.sgml | 2 | ||||
| -rw-r--r-- | doc/src/sgml/example-cluster.sgml | 2 | ||||
| -rw-r--r-- | doc/src/sgml/example-replication-si-mode.sgml | 4 | ||||
| -rw-r--r-- | doc/src/sgml/loadbalance.sgml | 2 | ||||
| -rw-r--r-- | doc/src/sgml/memcache.sgml | 8 | ||||
| -rw-r--r-- | doc/src/sgml/stream-check.sgml | 8 | ||||
| -rw-r--r-- | doc/src/sgml/watchdog.sgml | 6 |
9 files changed, 29 insertions, 29 deletions
diff --git a/doc/src/sgml/connection-pooling.sgml b/doc/src/sgml/connection-pooling.sgml index 9f6a751cd..f6ebb773c 100644 --- a/doc/src/sgml/connection-pooling.sgml +++ b/doc/src/sgml/connection-pooling.sgml @@ -791,7 +791,7 @@ </varlistentry> <varlistentry id="guc-log-backend-messages" xreflabel="log_backend_messages"> - <term><varname>log_backend_messages</varname> (<type>boolean</type>) + <term><varname>log_backend_messages</varname> (<type>enum</type>) <indexterm> <primary><varname>log_backend_messages</varname> configuration parameter</primary> </indexterm> diff --git a/doc/src/sgml/connection-settings.sgml b/doc/src/sgml/connection-settings.sgml index 262c76d05..0f78b9931 100644 --- a/doc/src/sgml/connection-settings.sgml +++ b/doc/src/sgml/connection-settings.sgml @@ -655,10 +655,10 @@ This mode is most popular and recommended clustering mode. In this mode <productname>PostgreSQL</productname> is responsible to replicate each servers. To enable this mode, use - 'streaming_replication' for + streaming_replication for <varname>backend_clustering_mode</varname>. <programlisting> -backend_clustering_mode = 'streaming_replication' +backend_clustering_mode = streaming_replication </programlisting> In this mode you can have up to 127 streaming replication standby servers. Also it is possible not to have standby server at all. @@ -686,10 +686,10 @@ backend_clustering_mode = 'streaming_replication' <para> This mode makes the <productname>Pgpool-II</productname> to replicate data between <productname>PostgreSQL</productname> - backends. To enable this mode, use 'native_replication' for + backends. To enable this mode, use native_replication for <varname>backend_clustering_mode</varname>. <programlisting> -backend_clustering_mode = 'native_replication' +backend_clustering_mode = native_replication </programlisting> In this mode you can have up to 127 standby replication servers. Also it is possible not to have standby server at all. @@ -1117,10 +1117,10 @@ backend_clustering_mode = 'native_replication' This mode is similar to the native replication mode except it adds the visibility consistency among nodes. The implementation is based on a research paper <xref linkend="mishima2009">. - To enable this mode, use 'snapshot_isolation' for + To enable this mode, use snapshot_isolation for <varname>backend_clustering_mode</varname>. <programlisting> -backend_clustering_mode = 'snapshot_isolation' +backend_clustering_mode = snapshot_isolation </programlisting> For example, you can avoid following inconsistency among nodes caused by the visibility inconsistency. Here S1 and S2 denotes sessions, while N1 @@ -1194,10 +1194,10 @@ default_transaction_isolation = 'repeatable read' <para> In this mode <productname>PostgreSQL</productname> is responsible to replicate - each servers. To enable this mode, use 'logical_replication' for + each servers. To enable this mode, use logical_replication for <varname>backend_clustering_mode</varname>. <programlisting> -backend_clustering_mode = 'logical_replication' +backend_clustering_mode = logical_replication </programlisting> In this mode you can have up to 127 logical replication standby servers. Also it is possible not to have standby server at all. @@ -1218,10 +1218,10 @@ backend_clustering_mode = 'logical_replication' <para> This mode is used to couple <productname>Pgpool-II</productname> with <acronym>Slony-I</acronym>. Slony-I is responsible for doing - the actual data replication. To enable this mode, use 'slony' for + the actual data replication. To enable this mode, use slony for <varname>backend_clustering_mode</varname>. <programlisting> -backend_clustering_mode = 'slony' +backend_clustering_mode = slony </programlisting> In this mode you can have up to 127 replica servers. Also it is possible not to have replica server at all. @@ -1247,9 +1247,9 @@ backend_clustering_mode = 'slony' In this mode, <productname>Pgpool-II</> does not care about the database synchronization. It's user's responsibility to make the whole system does a meaningful thing. Load balancing is <emphasis>not</emphasis> possible in the mode. - To enable this mode, use 'raw' for <varname>backend_clustering_mode</varname>. + To enable this mode, use raw for <varname>backend_clustering_mode</varname>. <programlisting> -backend_clustering_mode = 'raw' +backend_clustering_mode = raw </programlisting> </para> </sect2> diff --git a/doc/src/sgml/example-Aurora.sgml b/doc/src/sgml/example-Aurora.sgml index ce94f1927..540132f32 100644 --- a/doc/src/sgml/example-Aurora.sgml +++ b/doc/src/sgml/example-Aurora.sgml @@ -24,7 +24,7 @@ from <filename>pgpool.conf.sample</filename>. Make sure your <filename>pgpool.conf</filename> includes following line: <programlisting> -backend_clustering_mode = 'streaming_replication' +backend_clustering_mode = streaming_replication </programlisting> </para> </listitem> diff --git a/doc/src/sgml/example-cluster.sgml b/doc/src/sgml/example-cluster.sgml index d5a4150ea..cd12b0cda 100644 --- a/doc/src/sgml/example-cluster.sgml +++ b/doc/src/sgml/example-cluster.sgml @@ -679,7 +679,7 @@ pgpool:4aa0cb9673e84b06d4c8a848c80eb5d0 </para> <programlisting> [root@server1 ~]# vi /etc/pgpool-II/pgpool.conf -backend_clustering_mode = 'streaming_replication' +backend_clustering_mode = streaming_replication </programlisting> </sect3> diff --git a/doc/src/sgml/example-replication-si-mode.sgml b/doc/src/sgml/example-replication-si-mode.sgml index e06b91e77..e4280837a 100644 --- a/doc/src/sgml/example-replication-si-mode.sgml +++ b/doc/src/sgml/example-replication-si-mode.sgml @@ -432,7 +432,7 @@ default_transaction_isolation = 'repeatable read' Native replication mode </para> <programlisting> -backend_clustering_mode = 'native_replication' +backend_clustering_mode = native_replication </programlisting> </listitem> <listitem> @@ -440,7 +440,7 @@ backend_clustering_mode = 'native_replication' Snapshot isolation mode </para> <programlisting> -backend_clustering_mode = 'snapshot_isolation' +backend_clustering_mode = snapshot_isolation </programlisting> </listitem> </itemizedlist> diff --git a/doc/src/sgml/loadbalance.sgml b/doc/src/sgml/loadbalance.sgml index 2b186467a..ee19fabeb 100644 --- a/doc/src/sgml/loadbalance.sgml +++ b/doc/src/sgml/loadbalance.sgml @@ -1039,7 +1039,7 @@ app_name_redirect_preference_list > database_redirect_preference_list > us </varlistentry> <varlistentry id="guc-disable-load-balance-on-write" xreflabel="disable_load_balance_on_write"> - <term><varname>disable_load_balance_on_write</varname> (<type>string</type>) + <term><varname>disable_load_balance_on_write</varname> (<type>enum</type>) <indexterm> <primary><varname>disable_load_balance_on_write</varname> configuration parameter</primary> </indexterm> diff --git a/doc/src/sgml/memcache.sgml b/doc/src/sgml/memcache.sgml index 9888b8865..065de41ee 100644 --- a/doc/src/sgml/memcache.sgml +++ b/doc/src/sgml/memcache.sgml @@ -192,7 +192,7 @@ <variablelist> <varlistentry id="guc-memqcache-method" xreflabel="memqcache_method"> - <term><varname>memqcache_method</varname> (<type>string</type>) + <term><varname>memqcache_method</varname> (<type>enum</type>) <indexterm> <primary><varname>memqcache_method</varname> configuration parameter</primary> </indexterm> @@ -215,12 +215,12 @@ <tbody> <row> - <entry><literal>'shmem'</literal></entry> + <entry><literal>shmem</literal></entry> <entry>Use shared memory</entry> </row> <row> - <entry><literal>'memcached'</literal></entry> + <entry><literal>memcached</literal></entry> <entry>Use <ulink url="http://memcached.org/">memcached</ulink></entry> </row> @@ -245,7 +245,7 @@ If you are not sure which memqcache_method to be used, start with <varname>shmem</varname>. </para> <para> - Default is <literal>'shmem'</literal>. + Default is <literal>shmem</literal>. </para> <para> diff --git a/doc/src/sgml/stream-check.sgml b/doc/src/sgml/stream-check.sgml index 8515b6510..d2ca3ca49 100644 --- a/doc/src/sgml/stream-check.sgml +++ b/doc/src/sgml/stream-check.sgml @@ -310,7 +310,7 @@ GRANT pg_monitor TO sr_check_user; </varlistentry> <varlistentry id="guc-log-standby-delay" xreflabel="log_standby_delay"> - <term><varname>log_standby_delay</varname> (<type>string</type>) + <term><varname>log_standby_delay</varname> (<type>enum</type>) <indexterm> <primary><varname>log_standby_delay</varname> configuration parameter</primary> </indexterm> @@ -334,17 +334,17 @@ GRANT pg_monitor TO sr_check_user; <tbody> <row> - <entry><literal>'none'</literal></entry> + <entry><literal>none</literal></entry> <entry>Never log the standby delay</entry> </row> <row> - <entry><literal>'always'</literal></entry> + <entry><literal>always</literal></entry> <entry>Log the standby delay if it's greater than 0, every time the replication delay is checked</entry> </row> <row> - <entry><literal>'if_over_threshold'</literal></entry> + <entry><literal>if_over_threshold</literal></entry> <entry>Only log the standby delay, when it exceeds <xref linkend="guc-delay-threshold"> or <xref linkend="guc-delay-threshold-by-time"> value (the default)</entry> </row> </tbody> diff --git a/doc/src/sgml/watchdog.sgml b/doc/src/sgml/watchdog.sgml index 0a238f302..86812ce32 100644 --- a/doc/src/sgml/watchdog.sgml +++ b/doc/src/sgml/watchdog.sgml @@ -951,15 +951,15 @@ pgpool_port2 = 9999 <variablelist> <varlistentry id="guc-wd-lifecheck-method" xreflabel="wd_lifecheck_method"> - <term><varname>wd_lifecheck_method</varname> (<type>string</type>) + <term><varname>wd_lifecheck_method</varname> (<type>enum</type>) <indexterm> <primary><varname>wd_lifecheck_method</varname> configuration parameter</primary> </indexterm> </term> <listitem> <para> - Specifies the method of life check. This can be either of <literal>'heartbeat'</literal> (default), - <literal>'query'</literal> or <literal>'external'</literal>. + Specifies the method of life check. This can be either of <literal>heartbeat</literal> (default), + <literal>query</literal> or <literal>external</literal>. </para> <para> <literal>heartbeat</literal>: In this mode, watchdog sends the heartbeat signals (<acronym>UDP</acronym> packets) |
