What's New
Function Overview
Product Bulletin
- Product Notice
- Version Support Notes
Service Overview
- GaussDB(DWS) Infographics
- What Is GaussDB(DWS)?
- Data Warehouse Types
- Data Warehouse Flavors
- Advantages
- Application Scenarios
- Functions
- Concepts
- Related Services
- Security
- GaussDB(DWS) Permissions Management
- GaussDB(DWS) Access
- Restrictions
- Technical Support
- Service Quotas
- GaussDB(DWS) Technical Specifications
Billing
- GaussDB(DWS) Billing Overview
- Billing Modes
- Item
- Billing Examples
- Billing Mode Change
- Renewal
  - Overview
  - Manual Renewal
- Bills
- Arrears
- Stopping Billing
- Cost Management
- Billing FAQs
Getting Started
- Checkpoint Vehicle Analysis
- Supply Chain Requirement Analysis of a Company
- Operations Status Analysis of a Retail Department Store
- Creating a Time Series Table
- Best Practices of Hot and Cold Data Management
- Best Practices for Automatic Partition Management
- Creating a Cluster and Connecting to It
- Using CDM to Migrate MySQL Data to the GaussDB(DWS) Cluster
- Using DLI Flink Jobs to Write Kafka Data to GaussDB(DWS) in Real Time
- Basic SQL Operations
- Database Quick Start
- Getting Started with Common Practices
User Guide
- Using GaussDB(DWS)
- Preparations
- Creating a GaussDB(DWS) Cluster
- Connecting to a GaussDB(DWS) Cluster
- Creating a GaussDB(DWS) Database and User
- Migrating Service Data to a GaussDB(DWS) Cluster
  - Migrating Data to a GaussDB(DWS) Cluster Using GDS-Kafka
  - Data Source Management
- GaussDB(DWS) Cluster Data Security and Encryption
- GaussDB(DWS) Cluster Management
- GaussDB(DWS) Cluster O&M
Best Practices
- Import and Export
- Data Migration
- Data Analytics
- Decoupled Storage and Compute
  - DWS 3.0 Decoupled Storage and Compute Usage Suggestions and Performance Optimization
- Data Development
- Database Management
- Performance Tuning
  - Optimizing Table Structure Design to Enhance GaussDB(DWS) Query Performance
  - Analyzing SQL Statements That Are Being Executed to Handle GaussDB(DWS) Performance Issues
- Cluster Management
  - Binding Different Resource Pools to Two Types of Jobs to Balance Load for GaussDB(DWS)
  - Scaling Options for GaussDB(DWS) with a Coupled Storage-Compute Architecture
Data Migration and Synchronization
- Data Migration to GaussDB(DWS)
- Importing Data
- Full Database Migration
  - Using CDM to Migrate Data to GaussDB(DWS)
  - Using DSC to Migrate SQL Scripts
- Real-time Import
  - Using DRS to Import Data to GaussDB(DWS)
  - Real-time Data Import From Kafka GaussDB(DWS)
- Metadata Migration
  - Using gs_dump and gs_dumpall to Export Metadata
  - Using gs_restore to Import Data
- Exporting Data
- Other Operations
Developer Guide
- Standard Data Warehouse (9.1.0.x)
- Standard data warehouse (8.1.3.x)
- Hybrid Data Warehouse (9.1.0.x）
- Hybrid Data Warehouse (8.1.3.x）
- Historical Versions
SQL Syntax Reference
- SQL Syntax Reference (9.1.0.x)
- SQL Syntax Reference (8.1.3.x)
- Historical Versions
Performance Tuning
- Overview of Query Performance Optimization
- Query Execution Process
- SQL Execution Plan
- SQL Optimization Guide
- Optimization Cases
- SQL Execution Troubleshooting
- query_band Load Identification
- Common Performance Parameter Optimization Design
Tool Guide
- Overview
- Downloading Related Tools
- gsql
- Data Studio
- GDS
- DSC
- DataCheck
- DWS-Connector
- Server Tool
API Reference
- Before You Start
- API Overview
- Calling APIs
- Getting Started
- API Description
- Application Cases
  - Using Postman to Call the API for Creating a Cluster
  - Using Postman to Call the API for Creating a Snapshot
- Introduction
- Appendix
SDK Reference
- SDK Overview
FAQs
- Top FAQs
- Product Consulting
- Database Connections
- Data Migration
- Database Usage
- Cluster Management
- Account Permissions
- Database Performance
- Backup and Restoration
  1. Why Does It Take a Long Time to Create an Automated Snapshot in GaussDB(DWS)?
  2. Does a GaussDB(DWS) Snapshot Have the Same Function as an EVS Snapshot?
Troubleshooting
- Database Connections
- JDBC/ODBC
- Data Import and Export
- Database Parameter Modification
- Account/Permission/Password
- Cluster Performance
- Cluster Exceptions
  - The Disk Usage Alarm Is Frequently Generated
- Database Use
Videos
Performance White Paper
- Overview
- Test Result
  - TPC-H Single Query Test
  - TPC-DS Single Query Test
- Test Methods
- Appendixes
  - TPC-H Test Sets
  - TPC-DS Test Sets
Technical White Paper
- GaussDB(DWS)
- Platforms and Technical Specifications Supported by GaussDB(DWS)
  - Technical Specifications
- GaussDB(DWS) Core Technologies
- GaussDB(DWS) Tools
  - Client Tools
  - Database Monitoring Tool
- External APIs
Error Code Reference
- 8.2.0 and earlier versions
  - Management Console Error Code
  - Data Warehouse Service Error Codes
- 8.2.1 or later versions
Glossary
More Documents
- User Guide
- API Reference (ME-Abu Dhabi Region)
- Developer Guide (ME-Abu Dhabi Region)
- SQL Syntax Reference (ME-Abu Dhabi Region)
- Tool Guide (ME-Abu Dhabi Region)
- Error Code Reference (ME-Abu Dhabi Region)
  - Management Console Error Code
- User Guide (Paris Region)
- API Reference (Paris Region)
- Developer Guide (Paris Region)
- SQL Syntax Reference (Paris Region)
- Tool Guide (Paris Region)
- Error Code Reference (Paris Region)
  - Management Console Error Code
- User Guide (Kuala Lumpur Region)
- API Reference (Kuala Lumpur Region)
- Developer Guide (Kuala Lumpur Region)
- SQL Syntax Reference (Kuala Lumpur Region)
- Tool Guide (Kuala Lumpur Region)
- Error Code Reference (Kuala Lumpur Region)
  - Management Console Error Code
General Reference
- Glossary
- Service Level Agreement
- White Papers
- Endpoints
- Permissions

On this page

tcp_keepalives_idle
tcp_keepalives_interval
tcp_keepalives_count
comm_max_datanode
comm_max_stream
max_stream_pool
enable_stream_sync_quit
enable_connect_standby
comm_quota_size
comm_usable_memory
comm_client_bind
comm_no_delay
comm_debug_mode
comm_ackchk_time
comm_timer_mode
comm_stat_mode
client_connection_check_interval
conn_recycle_timeout

Show all

Help Center/ GaussDB(DWS)/ Developer Guide/ Standard Data Warehouse (9.1.0.x)/ GUC Parameters of the GaussDB(DWS) Database/ Connection and Authentication/ Communication Library Parameters

Communication Library Parameters

Updated on 2025-03-04 GMT+08:00

View PDF

This section describes parameter settings and value ranges for communication libraries.

tcp_keepalives_idle

Parameter description: Specifies the interval between keepalive signal sending in an OS that supports the TCP_KEEPIDLE socket parameter. If no keepalive signal is transmitted, the connection is in idle state.

Type: USERSET

NOTICE:

If the OS does not support the TCP_KEEPIDLE parameter, set this parameter to 0.
The parameter is ignored on the OS where connections are established using the Unix domain socket.

Value range: an integer ranging from 0 to 3600. The unit is second (s).

Default value: 0

tcp_keepalives_interval

Parameter description: Specifies the response time before retransmission when the OS supports the TCP_KEEPINTVL socket parameter.

Type: USERSET

Value range: an integer ranging from 0 to 180. The unit is second (s).

Default value: 0

NOTICE:

If the OS does not support the TCP_KEEPINTVL parameter, set this parameter to 0.
The parameter is ignored on the OS where connections are established using the Unix domain socket.

tcp_keepalives_count

Parameter description: Specifies the number of keepalived signals that can be waited before the GaussDB(DWS) server is disconnected from the client if the OS supports the TCP_KEEPCNT socket parameter.

Type: USERSET

NOTICE:

If the OS does not support the TCP_KEEPCNT parameter, set this parameter to 0.
The parameter is ignored on the OS where connections are established using the Unix domain socket.

Value range: an integer ranging from 0 to 100. 0 indicates that the connection is immediately broken if GaussDB(DWS) does not receive a keepalived signal from the client.

Default value: 0

comm_max_datanode

Parameter description: Specifies the maximum number of DNs supported by the communication library.

Type: USERSET

Value range: an integer ranging from 1 to 8192

Default value: actual number of DNs

NOTICE:

Increasing this parameter value takes effect immediately, while decreasing the value takes effect after the cluster is restarted.

comm_max_stream

Parameter description: maximum number of logical connection data structures cached in the communication library.

Type: SIGHUP

Value range: an integer ranging from 1 to 65535

Default value: 1024

NOTE:

If the value of comm_max_datanode is small, the process memory is sufficient. In this case, you can increase the value of comm_max_stream.

max_stream_pool

Parameter description: Specifies the maximum number of stream threads that can be contained in a stream thread pool. This feature is supported in 8.1.2 or later.

Type: SUSET

Value range: an integer ranging from –1 to INT_MAX. The values –1 and 0 indicate that the stream thread pool is disabled.

Default value:

The formula for a new cluster is max_stream_pool=MIN(max_connections, max_process_memory/16/5MB, 1024).
The formula for a cluster upgraded from versions earlier than is max_stream_pool = MIN(max_connections, max_process_memory/16/5MB, 1024, value of the old cluster). During the upgrade, the settings for the new cluster are forcibly used. The old value is used if it is smaller.

NOTE:

The number of stream threads in a thread pool can be reduced in real time. If the value of this parameter is increased, the number of stream threads is increased to meet the service requirements.
Generally, you are advised not to change the value of this parameter because the stream thread pool supports the automatic cleanup function.
If too many idle stream threads occupy the memory, you can decrease the value of this parameter to save the memory.

enable_stream_sync_quit

Parameter description: whether the stream threads exit synchronously when the stream plan ends. This parameter is supported only by clusters of version 8.3.0 or later.

Type: USERSET

Value range: Boolean

on indicates that threads in the stream thread group exit after the stream plan ends.
off indicates that stream threads exit directly after the stream plan ends without waiting for the threads in the stream thread group to exit.

Default value: off

enable_connect_standby

Parameter description: Sets the connection between a CN and a standby DN. This parameter is supported only by clusters of version 8.3.0 or later.

Type: USERSET

Value range: Boolean

on indicates that the CN connects to the standby server.
off indicates that the CN connects to the primary DN.

Default value: off

CAUTION:

You are not advised to use this parameter in routine services. This parameter applies only to O&M operations. You are not advised to use the gs_guc tool for global settings. Otherwise, problems such as data inconsistency and result set errors may occur.
Enabling this parameter for a session with temporary tables will delete the temporary table data on DNs and prevent further actions on those tables.

comm_quota_size

Parameter description: Specifies the maximum size of packets that can be continuously sent by the communication library. When you use a 1GE NIC, a small value ranging from 20 KB to 40 KB is recommended.

Type: USERSET

Value range: an integer ranging from 0 to 102400. The default unit is KB. The value 0 indicates that the quota mechanism is not used.

Default value: 1 MB

comm_usable_memory

Parameter description: Specifies the maximum memory that can be used by the communication library cache on a single DN.

Type: SIGHUP

Value range: an integer ranging from 1 to 256. The default unit is KB. The minimum size cannot be less than 1 GB for installation.

Default value: max_process_memory/8

NOTICE:

This parameter must be specifically set based on environment memory and the deployment method. If it is too large, out-of-memory (OOM) may occur. If it is too small, the performance of the communication library may deteriorate.

comm_client_bind

Parameter description: Specifies whether to bind the client of the communication library to a specified IP address when the client initiates a connection.

Type: USERSET

Value range: Boolean

on indicates that the client is bound to a specified IP address.
off indicates that the client is not bound to any IP addresses.

NOTICE:

If multiple IP addresses of a node in a cluster are on the same communication network segment, set this parameter to on. In this case, the client is bound to the IP address specified by listen_addresses. The concurrency performance of a cluster depends on the number of random ports because a port can be used only by one client at a time.

Default value: off

comm_no_delay

Parameter description: Specifies whether to use the NO_DELAY attribute of the communication library connection. Restart the cluster for the setting to take effect.

Type: USERSET

Value range: Boolean

Default value: off

NOTICE:

If packet loss occurs because a large number of packets are received per second, set this parameter to off to reduce the total number of packets.

comm_debug_mode

Parameter description: Specifies the debug mode of the communication library, that is, whether to print logs about the communication layer. The setting is effective at the session layer.

NOTICE:

When the switch is set to on, the number of printed logs is huge, adding extra overhead and reducing database performance. Therefore, set the switch to on only in the debug mode.

Type: USERSET

Value range: Boolean

on indicates the detailed debug log of the communication library is printed.
off indicates the detailed debug log of the communication library is not printed.

Default value: off

comm_ackchk_time

Parameter description: Specifies the duration after which the communication library server automatically triggers ACK when no data package is received.

Type: USERSET

Value range: an integer ranging from 0 to 20000. The unit is millisecond (ms). 0 indicates that automatic ACK triggering is disabled.

Default value: 2000

comm_timer_mode

Parameter description: Specifies the timer mode of the communication library, that is, whether to print timer logs in each phase of the communication layer. The setting is effective at the session layer.

NOTICE:

When the switch is set to on, the number of printed logs is huge, adding extra overhead and reducing database performance. Therefore, set the switch to on only in the debug mode.

Type: USERSET

Value range: Boolean

on indicates the detailed timer log of the communication library is printed.
off indicates the detailed timer log of the communication library is not printed.

Default value: off

comm_stat_mode

Parameter description: Specifies the stat mode of the communication library, that is, whether to print statistics about the communication layer. The setting is effective at the session layer.

NOTICE:

When the switch is set to on, the number of printed logs is huge, adding extra overhead and reducing database performance. Therefore, set the switch to on only in the debug mode.

Type: USERSET

Value range: Boolean

on indicates the statistics log of the communication library is printed.
off indicates the statistics log of the communication library is not printed.

Default value: off

client_connection_check_interval

Parameter description: Specifies the interval for checking the client connection status. This parameter is supported by clusters of version 8.2.0 or later.

Type: USERSET

Value range: an integer ranging from 0 to INT_MAX. The unit is ms. The value 0 indicates that the client connection status is not checked.

Default value: 10000

NOTICE:

During a long query executed in a session where a client (such as gsql, JDBC, or ODBC) directly connects to the CN,

The CN checks the client connection status at the interval specified by client_connection_check_interval. If it detects that the client has been disconnected from the CN, the server terminates the long query and releases related resources to avoid waste of cluster resources.
The DN checks its connection to the CN at the interval specified by client_connection_check_interval. If the DN detects that it has been disconnected from the CN, it terminates the long query and releases related resources to avoid waste of cluster resources.

conn_recycle_timeout

Parameter description: the interval for reclaiming idle connections between a CN and other nodes to the connection pool. This parameter is supported only by clusters of version 8.2.1 or later.

Type: USERSET

Value range: an integer ranging from 0 to 3600, in second (s). 0 indicates that the function of reclaiming idle connections is disabled.

Default value: 30

Parent topic: Connection and Authentication

Previous topic: Security and Authentication (postgresql.conf)

Next topic: Resource Consumption

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot