Add TCP keepalive support for long queries - #1337
Closed
sonnemusk wants to merge 1 commit into
Closed
Conversation
Support libpq keepalive connection parameters so client-side TCP keepalives can be enabled, disabled, or tuned for long-running queries behind NATs and load balancers: keepalives=0|1 keepalives_idle=<seconds> keepalives_interval=<seconds> keepalives_count=<n> Settings are applied after dial via *net.TCPConn.SetKeepAlive / SetKeepAliveConfig when the connection is TCP (including NetConn wrappers such as *tls.Conn). Unix sockets and non-TCP dials are left unchanged. Omitting the parameters leaves the dialer's defaults alone. Fixes #360
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Implements client-side TCP keepalive support for long-running queries (e.g. behind NATs, load balancers, or Redshift), addressing #360.
This supersedes the stale approach in #999 (2020). That PR wired
net.Dialer.KeepAliveonly (idle and interval forced to the same value, no count). This implementation:keepalives,keepalives_idle,keepalives_interval,keepalives_count*net.TCPConnviaSetKeepAlive/SetKeepAliveConfig(Go 1.23+), so idle, interval, and count can be set independentlyNetConn()wrapper such as*tls.Conn)Example:
Fields are also available on
pq.Config.Test plan
Runtime)setTCPKeepalivesagainst a real local TCP listener (enable/disable/tuning/non-TCP/no-op/NetConn unwrap)Fixes #360