Updated on 2024-06-03 GMT+08:00

Sending Server

max_wal_senders

Parameter description: Specifies the maximum number of concurrent connections of the transaction log sender. The value must be smaller than that of max_connections.

wal_level must be set to archive, hot_standby, or logical to allow the connection from standby nodes.

Parameter type: integer.

Value range: 0 to 1024. The recommended value range is 8 to 100.

Default value:

Setting method: This is a POSTMASTER parameter. Set it based on instructions provided in Table 1.

Setting suggestions: 1. It can be set to 0 only when a single DN is used and there is no primary/standby instance. 2. When HA replication, backup and restoration, and logical decoding are used, you are advised to set this parameter to a value by referring to the following formula: Number of current standby nodes + Number of backup connections + Number of required logical replication connections. If the actual value is smaller than the recommended value, these functions may be unavailable or abnormal.

wal_keep_segments

Parameter description: Specifies the number of Xlog file segments. It specifies the minimum number of transaction log files stored in the pg_xlog directory. The standby node obtains the logs from the primary node to perform streaming replication.

Parameter type: integer.

Value range: 2 to INT_MAX

Default value: 128

Setting method: This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Setting suggestion:

  • During WAL archiving or recovery from a checkpoint on the server, the system may retain more log files than the number specified by wal_keep_segments.
  • If this parameter is set to an excessively small value, a transaction log may have been overwritten by a new transaction before requested by the standby node. As a result, the request fails and the connection between the primary and standby nodes is terminated.
  • If the HA system uses asynchronous transmission, increase the value of wal_keep_segments when data greater than 4 GB is continuously imported in COPY mode. Take T6000 board as an example. If the data to be imported reaches 50 GB, you are advised to set this parameter to 1000. You can dynamically restore the setting of this parameter after data import is complete and the log synchronization is normal.
  • If the synchronous_commit level is lower than LOCAL_FLUSH, you are advised to set this parameter to 1000 when rebuilding the standby node to prevent rebuilding failures caused by primary node log recycling during the rebuilding.

wal_sender_timeout

Parameter description: Specifies the maximum duration that the sender waits for the receiver to receive transaction logs.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

  • If the data volume on the primary node is huge, the value of this parameter must be increased for rebuilding. For example, if the data volume on the primary node reaches 500 GB, you are advised to set this parameter to 600 seconds.
  • This parameter cannot be set to a value larger than the value of wal_receiver_timeout or the timeout parameter for database rebuilding.

Value range: an integer ranging from 0 to 2147483647. The unit is ms.

Default value: 6s

max_replication_slots

Parameter description: Specifies the number of log replication slots on the primary node.

Parameter type: integer.

Value range: 0 to 1024. The recommended value range is 8 to 100.

Default value: 20

Setting method: This is a POSTMASTER parameter. Set it based on instructions provided in Table 1.

Setting suggestion:

When HA replication, backup and restoration, and logical decoding are used, you are advised to set this parameter to a value by referring to the following formula: Number of current physical streaming replication slots + Number of backup slots + Number of required logical replication slots. If the actual value is smaller than the recommended value, these functions may be unavailable or abnormal.

Physical streaming replication slots provide an automatic method to ensure that Xlogs are not removed from a primary DN before they are received by all the standby DNs. That is, physical streaming replication slots are used to support cluster HA. The number of physical streaming replication slots required by the cluster is as follows: ratio of the number of standby and secondary DNs to the number of primary DNs in a ring of DNs. If the HA DN has 1 primary cluster and 3 standby clusters, the number of physical streaming replication slots required is 3.

Backup slot records replication information during backup execution. Full backup and incremental backup correspond to two independent backup slots.

Plan the number of logical replication slots as follows:
  • A logical replication slot can carry changes of only one database for decoding. If multiple databases are involved, create multiple logical replication slots.
  • If logical replication is needed by multiple target databases, create multiple logical replication slots in the source database. Each logical replication slot corresponds to one logical replication link.
  • A maximum of 20 logical replication slots can be enabled for decoding on the same instance.

max_keep_log_seg

Parameter description: Stream control parameter. In logical replication, physical logs are parsed and converted into logical logs locally on the DN. When the number of physical log files that are not parsed is greater than the value of this parameter, stream control is triggered. The value 0 indicates that the stream control function is disabled.

This is a USERSET parameter. Set it based on instructions provided in Table 1.

Value range: an integer ranging from 0 to 2147483647

Default value: 0

enable_logicalrepl_xlog_prune

Parameter description: Specifies whether to enable the function of forcibly invalidating a logical replication slot. When the current GUC parameters enable_logicalrepl_xlog_prune is set to on, enable_xlog_prune is set to on, and max_size_for_xlog_retention is set to a non-zero value, the number of reserved log segments caused by the backup slot or logical replication slot exceeds the value of wal_keep_segments, and other replication slots do not cause more reserved log segments, if the value of max_size_for_xlog_retention is greater than 0 and the number of retained log segments (the size of each log segment is 16 MB) caused by the current logical replication slot exceeds the value of max_size_for_xlog_retention, or if the value of max_size_for_xlog_retention is less than 0 and the disk usage reaches the value of –max_size_for_xlog_retention/100, the logical replication slot is forcibly invalidated and restart_lsn is set to 7FFFFFFF/FFFFFFFF.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: Boolean

  • true indicates that the function of forcibly invalidating a logical replication slot is enabled.
  • false indicates that the function of forcibly invalidating a logical replication slot is disabled.

Default value: false

enable_wal_shipping_compression

Parameter description: Specifies whether to enable cross-cluster log compression in streaming DR mode.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

  • This parameter applies only to a pair of WAL senders and WAL receivers for cross-cluster transmission in streaming DR and is configured in the primary cluster.

Value range: Boolean

  • true indicates that cross-cluster log compression is enabled in streaming DR mode.
  • false indicates that cross-cluster log compression is disabled in streaming DR mode.

Default value: false

repl_auth_mode

Parameter description: Specifies the validation mode for primary/standby replication and standby node rebuilding.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

  • If UUID validation is enabled on the primary node and a non-null repl_uuid validation code is configured, UUID validation must also be enabled on the standby node and the same repl_uuid validation code must be configured on the standby node. Otherwise, requests for log replication between the primary and standby nodes and standby node rebuilding will be rejected by the primary node.
  • The SIGHUP parameter can dynamically load new values. The modification does not affect the established primary/standby connection and takes effect for subsequent primary/standby replication requests and primary/standby rebuilding requests.
  • It supports the standby node rebuild validation under the Quorum and DCF protocols and the primary/standby replication validation under the Quorum protocol. It does not support primary/standby replication validation under the DCF protocol.
  • It does not support the authentication between the primary and standby nodes across clusters, including the primary/standby Dorado and DR clusters.
  • The UUID validation function is used to prevent data crosstalk and pollution caused by incorrect connection between the primary and standby nodes. It is not used for security purposes.
  • This parameter cannot be automatically synchronized between the primary and standby nodes.

Value range: enumerated values

  • off: indicates that UUID validation is disabled.
  • default: indicates that UUID validation is disabled.
  • uuid: indicates that UUID validation is enabled.

Default value: default

repl_uuid

Parameter description: Specifies the UUID used for primary/standby UUID validation.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

  • If UUID validation is enabled on the primary node and a non-null repl_uuid validation code is configured, UUID validation must also be enabled on the standby node and the same repl_uuid validation code must be configured on the standby node. Otherwise, requests for log replication between the primary and standby nodes and standby node rebuilding will be rejected by the primary node.
  • The SIGHUP parameter can dynamically load new values. The modification does not affect the established primary/standby connection and takes effect for subsequent primary/standby replication requests and primary/standby rebuilding requests.
  • It supports the standby node rebuild validation under the Quorum and DCF protocols and the primary/standby replication validation under the Quorum protocol. It does not support primary/standby replication validation under the DCF protocol.
  • It does not support the authentication between the primary and standby nodes across clusters, including the primary/standby Dorado and DR clusters.
  • The UUID validation function is used to prevent data crosstalk and pollution caused by incorrect connection between the primary and standby nodes. It is not used for security purposes.
  • This parameter cannot be automatically synchronized between the primary and standby nodes.

Value range: a string. The value contains 0 to 63 characters, including letters and digits. The value is case-insensitive and is converted to lowercase letters for storage. An empty string indicates that UUID validation is disabled.

Default value: an empty string

replconninfo1

Parameter description: Specifies the information about the first node to be listened on and authenticated by the current server. This parameter is automatically configured after the cluster is successfully installed.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: a string. An empty string indicates that no information about the first node is configured.

Default value: information about the first connection listened to by the DN.

Example:

replconninfo1 = 'localhost=127.0.0.1 localport=XXXX localheartbeatport=XXXX localservice=XXXX remotehost=127.0.0.1 remoteport=XXXX remoteheartbeatport=XXXX remoteservice=XXXX'

replconninfo2

Parameter description: Specifies the information about the second node to be listened on and authenticated by the current server. This parameter is automatically configured after the cluster is successfully installed.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: a string. An empty string indicates that no information about the second node is configured.

Default value: information about the second connection listened to by the DN.

Example:

replconninfo2 = 'localhost=127.0.0.1 localport=XXXX localheartbeatport=XXXX localservice=XXXX remotehost=127.0.0.1 remoteport=XXXX remoteheartbeatport=XXXX remoteservice=XXXX'

replconninfo3

Parameter description: Specifies the information about the third node to be listened on and authenticated by the current server. This parameter is automatically configured after the cluster is successfully installed.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: a string. An empty string indicates that no information about the third node is configured.

Default value: information about the third connection listened to by the DN.

Example:

replconninfo3 = 'localhost=127.0.0.1 localport=XXXX localheartbeatport=XXXX localservice=XXXX remotehost=127.0.0.1 remoteport=XXXX remoteheartbeatport=XXXX remoteservice=XXXX'

replconninfo4

Parameter description: Specifies the information about the fourth node to be listened on and authenticated by the current server. This parameter is automatically configured after the cluster is successfully installed.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: a string. An empty string indicates that no information about the fourth node is configured.

Default value: information about the fourth connection listened to by the DN.

Example:

replconninfo4 = 'localhost=127.0.0.1 localport=XXXX localheartbeatport=XXXX localservice=XXXX remotehost=127.0.0.1 remoteport=XXXX remoteheartbeatport=XXXX remoteservice=XXXX'

replconninfo5

Parameter description: Specifies the information about the fifth node to be listened on and authenticated by the current server. This parameter is automatically configured after the cluster is successfully installed.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: a string. An empty string indicates that no information about the fifth node is configured.

Default value: information about the fifth connection listened to by the DN.

Example:

replconninfo5 = 'localhost=127.0.0.1 localport=XXXX localheartbeatport=XXXX localservice=XXXX remotehost=127.0.0.1 remoteport=XXXX remoteheartbeatport=XXXX remoteservice=XXXX'

replconninfo6

Parameter description: Specifies the information about the sixth node to be listened on and authenticated by the current server. This parameter is automatically configured after the cluster is successfully installed.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: a string. An empty string indicates that no information about the sixth node is configured.

Default value: information about the sixth connection listened to by the DN.

Example:

replconninfo6 = 'localhost=127.0.0.1 localport=XXXX localheartbeatport=XXXX localservice=XXXX remotehost=127.0.0.1 remoteport=XXXX remoteheartbeatport=XXXX remoteservice=XXXX'

replconninfo7

Parameter description: Specifies the information about the seventh node to be listened on and authenticated by the current server. This parameter is automatically configured after the cluster is successfully installed.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: a string. An empty string indicates that no information about the seventh node is configured.

Default value: information about the seventh connection listened to by the DN.

Example:

replconninfo7 = 'localhost=127.0.0.1 localport=XXXX localheartbeatport=XXXX localservice=XXXX remotehost=127.0.0.1 remoteport=XXXX remoteheartbeatport=XXXX remoteservice=XXXX'

cross_cluster_replconninfo1

Parameter description: Specifies the information about the first node to be listened on and authenticated by the current server across clusters.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: a string. An empty string indicates that no information about the first node is configured.

Default value: an empty string

cross_cluster_replconninfo2

Parameter description: Specifies the information about the second node to be listened on and authenticated by the current server across clusters.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: a string. An empty string indicates that no information about the second node is configured.

Default value: an empty string

cross_cluster_replconninfo3

Parameter description: Specifies the information about the third node to be listened on and authenticated by the current server across clusters.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: a string. An empty string indicates that no information about the third node is configured.

Default value: an empty string

cross_cluster_replconninfo4

Parameter description: Specifies the information about the fourth node to be listened on and authenticated by the current server across clusters.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: a string. An empty string indicates that no information about the fourth node is configured.

Default value: an empty string

cross_cluster_replconninfo5

Parameter description: Specifies the information about the fifth node to be listened on and authenticated by the current server across clusters.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: a string. An empty string indicates that no information about the fifth node is configured.

Default value: an empty string

cross_cluster_replconninfo6

Parameter description: Specifies the information about the sixth node to be listened on and authenticated by the current server across clusters.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: a string. An empty string indicates that no information about the sixth node is configured.

Default value: an empty string

cross_cluster_replconninfo7

Parameter description: Specifies the information about the seventh node to be listened on and authenticated by the current server across clusters.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: a string. An empty string indicates that no information about the seventh node is configured.

Default value: an empty string

cross_cluster_replconninfo8

Parameter description: Specifies the information about the eighth node to be listened on and authenticated by the current server across clusters.

This is a SIGHUP parameter. Set it based on instructions provided in Table 1.

Value range: a string. An empty string indicates that no information about the eighth node is configured.

Default value: an empty string

enable_time_report

Parameter description: Specifies whether to record the time consumed by each redo log.

This is a POSTMASTER parameter. Set it based on instructions provided in Table 1.

Value range: Boolean
  • on indicates that the time when a redo record is generated is recorded.
  • off indicates that no record is generated.

Default value: off

thread_top_level

Parameter description: Increases the priority of the WALWRITERAUXILIARY || WALWRITER || STARTUP ||WALRECEIVER || WAL_NORMAL_SENDER || PGSTAT threads to the highest.

This is a POSTMASTER parameter. Set it based on instructions provided in Table 1.

Value range: Boolean
  • on indicates that the priority of the preceding threads is increased to the highest.
  • off indicates that the priority of the preceding threads is not increased.

Default value: off

page_work_queue_size

Parameter description: Specifies the length of the blocking queue of each redo worker.

This is a POSTMASTER parameter. Set it based on instructions provided in Table 1.

Value range: a value ranging from 1 to 100000.

Default value: 4096