From b5c5951435ec91e038558e8e297d17fa831dab28 Mon Sep 17 00:00:00 2001 From: Taiki Koshino Date: Tue, 8 Jul 2025 15:52:10 +0900 Subject: [PATCH v3] Doc: fix documentation for enum parameters reported as strings Fix documentations for 5 parameters. Japanese docs too. "log_standby_delay" "log_backend_messages" "wd_lifecheck_method" "memqcache_method" "disable_load_balance_on_write" --- doc.ja/src/sgml/connection-pooling.sgml | 2 +- doc.ja/src/sgml/loadbalance.sgml | 2 +- doc.ja/src/sgml/memcache.sgml | 10 +++---- doc.ja/src/sgml/stream-check.sgml | 8 +++--- doc.ja/src/sgml/watchdog.sgml | 10 +++---- doc/src/sgml/connection-pooling.sgml | 2 +- doc/src/sgml/loadbalance.sgml | 2 +- doc/src/sgml/memcache.sgml | 8 +++--- doc/src/sgml/stream-check.sgml | 8 +++--- doc/src/sgml/watchdog.sgml | 6 ++--- src/sample/pgpool.conf.sample-stream | 36 ++++++++++++------------- 11 files changed, 47 insertions(+), 47 deletions(-) diff --git a/doc.ja/src/sgml/connection-pooling.sgml b/doc.ja/src/sgml/connection-pooling.sgml index 50b7a23c6..e9c8253c7 100644 --- a/doc.ja/src/sgml/connection-pooling.sgml +++ b/doc.ja/src/sgml/connection-pooling.sgml @@ -1214,7 +1214,7 @@ local0.* /var/log/pgpool.log - log_backend_messages (boolean) + log_backend_messages (enum) @@ -298,7 +298,7 @@ - 'memcached' + memcached @@ -338,9 +338,9 @@ - デフォルトは'shmem'です。 + デフォルトはshmemです。 diff --git a/doc.ja/src/sgml/stream-check.sgml b/doc.ja/src/sgml/stream-check.sgml index 7295faef9..4b3a85e69 100644 --- a/doc.ja/src/sgml/stream-check.sgml +++ b/doc.ja/src/sgml/stream-check.sgml @@ -388,7 +388,7 @@ GRANT pg_monitor TO sr_check_user; - log_standby_delay (string) + log_standby_delay (enum) @@ -434,7 +434,7 @@ GRANT pg_monitor TO sr_check_user; - 'always' + always @@ -442,7 +442,7 @@ GRANT pg_monitor TO sr_check_user; - 'if_over_threshold' + if_over_threshold diff --git a/doc.ja/src/sgml/watchdog.sgml b/doc.ja/src/sgml/watchdog.sgml index ceb546079..b4eff8db6 100644 --- a/doc.ja/src/sgml/watchdog.sgml +++ b/doc.ja/src/sgml/watchdog.sgml @@ -1320,7 +1320,7 @@ - wd_lifecheck_method (string) + wd_lifecheck_method (enum) 死活監視の方法を指定します。 - 指定できる値は 'heartbeat' (デフォルト)、'query'、または'external' です。 + 指定できる値は heartbeat (デフォルト)、query、またはexternal です。 - 'heartbeat'を指定した場合には、監視は「ハートビートモード」で行われます。 + heartbeatを指定した場合には、監視は「ハートビートモード」で行われます。 watchdog は一定間隔でハートビート信号(UDP パケット)を他のPgpool-IIへ送信します。 またwatchdogは他のPgpool-IIから送られてくる信号を受信します。 これが一定時間以上途絶えた場合にはそのPgpool-IIに障害が発生したと判断します。 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 @@ - log_backend_messages (boolean) + log_backend_messages (enum) log_backend_messages configuration parameter 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 - disable_load_balance_on_write (string) + disable_load_balance_on_write (enum) disable_load_balance_on_write configuration parameter 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 @@ - memqcache_method (string) + memqcache_method (enum) memqcache_method configuration parameter @@ -215,12 +215,12 @@ - 'shmem' + shmem Use shared memory - 'memcached' + memcached Use memcached @@ -245,7 +245,7 @@ If you are not sure which memqcache_method to be used, start with shmem. - Default is 'shmem'. + Default is shmem. 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; - log_standby_delay (string) + log_standby_delay (enum) log_standby_delay configuration parameter @@ -334,17 +334,17 @@ GRANT pg_monitor TO sr_check_user; - 'none' + none Never log the standby delay - 'always' + always Log the standby delay if it's greater than 0, every time the replication delay is checked - 'if_over_threshold' + if_over_threshold Only log the standby delay, when it exceeds or value (the default) 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 - wd_lifecheck_method (string) + wd_lifecheck_method (enum) wd_lifecheck_method configuration parameter - Specifies the method of life check. This can be either of 'heartbeat' (default), - 'query' or 'external'. + Specifies the method of life check. This can be either of heartbeat (default), + query or external. heartbeat: In this mode, watchdog sends the heartbeat signals (UDP packets) diff --git a/src/sample/pgpool.conf.sample-stream b/src/sample/pgpool.conf.sample-stream index 9478198d7..a3bd6e163 100644 --- a/src/sample/pgpool.conf.sample-stream +++ b/src/sample/pgpool.conf.sample-stream @@ -262,7 +262,7 @@ backend_clustering_mode = 'streaming_replication' # Log any backend messages # Valid values are none, terse and verbose -#log_standby_delay = 'if_over_threshold' +#log_standby_delay = if_over_threshold # Log standby delay # Valid values are combinations of always, # if_over_threshold, none @@ -457,33 +457,33 @@ backend_clustering_mode = 'streaming_replication' # If off, SQL comments effectively prevent the judgment # (pre 3.4 behavior). -#disable_load_balance_on_write = 'transaction' +#disable_load_balance_on_write = transaction # Load balance behavior when write query is issued # in an explicit transaction. # # Valid values: # - # 'transaction' (default): + # transaction (default): # if a write query is issued, subsequent # read queries will not be load balanced # until the transaction ends. # - # 'trans_transaction': + # trans_transaction: # if a write query is issued, subsequent # read queries in an explicit transaction # will not be load balanced until the session ends. # - # 'dml_adaptive': + # dml_adaptive: # Queries on the tables that have already been # modified within the current explicit transaction will # not be load balanced until the end of the transaction. # - # 'always': + # always: # if a write query is issued, read queries will # not be load balanced until the session ends. # # Note that any query not in an explicit transaction - # is not affected by the parameter except 'always'. + # is not affected by the parameter except always. #dml_adaptive_object_relationship_list= '' # comma separated list of object pairs @@ -494,7 +494,7 @@ backend_clustering_mode = 'streaming_replication' # example: 'tb_t1:tb_t2,insert_tb_f_func():tb_f,tb_v:my_view' # Note: function name in this list must also be present in # the write_function_list - # only valid for disable_load_balance_on_write = 'dml_adaptive'. + # only valid for disable_load_balance_on_write = dml_adaptive. #statement_level_load_balance = off # Enables statement level load balancing @@ -855,8 +855,8 @@ backend_clustering_mode = 'streaming_replication' # '' to disable monitoring # (change requires restart) -#wd_lifecheck_method = 'heartbeat' - # Method of watchdog lifecheck ('heartbeat' or 'query' or 'external') +#wd_lifecheck_method = heartbeat + # Method of watchdog lifecheck (heartbeat or query or external) # (change requires restart) #wd_interval = 10 # lifecheck interval (sec) > 0 @@ -964,27 +964,27 @@ backend_clustering_mode = 'streaming_replication' #memory_cache_enabled = off # If on, use the memory cache functionality, off by default # (change requires restart) -#memqcache_method = 'shmem' - # Cache storage method. either 'shmem'(shared memory) or - # 'memcached'. 'shmem' by default +#memqcache_method = shmem + # Cache storage method. either shmem(shared memory) or + # memcached. shmem by default # (change requires restart) #memqcache_memcached_host = 'localhost' # Memcached host name or IP address. Mandatory if - # memqcache_method = 'memcached'. + # memqcache_method = memcached. # Defaults to localhost. # (change requires restart) #memqcache_memcached_port = 11211 - # Memcached port number. Mandatory if memqcache_method = 'memcached'. + # Memcached port number. Mandatory if memqcache_method = memcached. # Defaults to 11211. # (change requires restart) #memqcache_total_size = 64MB # Total memory size in bytes for storing memory cache. - # Mandatory if memqcache_method = 'shmem'. + # Mandatory if memqcache_method = shmem. # Defaults to 64MB. # (change requires restart) #memqcache_max_num_cache = 1000000 # Total number of cache entries. Mandatory - # if memqcache_method = 'shmem'. + # if memqcache_method = shmem. # Each cache entry consumes 48 bytes on shared memory. # Defaults to 1,000,000(45.8MB). # (change requires restart) @@ -1002,7 +1002,7 @@ backend_clustering_mode = 'streaming_replication' # Must be smaller than memqcache_cache_block_size. Defaults to 400KB. # (change requires restart) #memqcache_cache_block_size = 1MB - # Cache block size in bytes. Mandatory if memqcache_method = 'shmem'. + # Cache block size in bytes. Mandatory if memqcache_method = shmem. # Defaults to 1MB. # (change requires restart) #memqcache_oiddir = '/var/log/pgpool/oiddir' -- 2.43.5