Releases: jackc/pgx
Release list
v5.11.0
This release adds direct PostgreSQL type scanning through database/sql on Go 1.27, improves compatibility with
libpq connection strings and PostgreSQL date/time values, and includes further decoder hardening. See Changes for
connection-string and date/time behavior changes that may affect existing applications.
Features
- stdlib: support Go 1.27's
driver.RowsColumnScanner, allowing PostgreSQL types such as arrays and ranges to be
scanned directly into Go values withoutpgtype.Map.SQLScanner. Existingdatabase/sqlscalar conversions and
sql.Scannerbehavior are preserved. The minimum supported Go version remains 1.25. - Add
Rows.TypeMapto expose the type map used to decode rows, including rows created byRowsFromResultReader
that have no underlyingConn. Custom implementations ofRows, including mocks, must add this method. - pgconn: add
Config.MaxProtocolMessageBodyLento configure the maximum incoming protocol message body size
(carter-ya) - pgconn: add
ErrReadOnlyConnection,ErrReadWriteConnection,ErrPrimaryConnection, andErrStandbyConnection
sentinel errors fortarget_session_attrsvalidation, allowing callers to useerrors.Is(Adrian-Stefan Mares) - pgxpool: accept
pool_ping_timeoutin connection strings to configureConfig.PingTimeout. The default is zero;
zero and negative durations mean no timeout (1991santhu)
Changes
-
Name-based row-to-struct mapping now matches explicit
dbtags case-insensitively, with exact matches taking
precedence so tags can still distinguish quoted column names that differ only by case (AlisinaDevelo) -
pgconn: resolve the OS user account only when no user is supplied by the connection string, environment, or service
file, avoiding unnecessary account lookups and crashes in some restricted container environments. Home-directory
defaults for password, service, and TLS files remain available independently of the account lookup. On Unix these
now use$HOMErather than the OS account's home directory (Mohamed MAACHE) -
pgtype:
date,timestampandtimestamptztext values are now parsed and written by a hand-written parser and
encoder for PostgreSQL's ISO date/time format instead oftime.Parseandtime.Format. Go's layout language cannot
express a variable-width year or the BC era, which is the root of the bugs below. The text scan path is roughly 2.5x
faster fortimestampandtimestamptz. Bug fixes:timestampandtimestamptzno longer silently move February 29 of a BC leap year to March 1 when encoding.
time.Date(-4712, 2, 29, ...)was written as4713-03-01 BCand is now written as4713-02-29 BC. This
affected ordinary four-digit BC years, not only extended-range ones.datewas never affected.timestampandtimestamptzcan now scan BC leap days.4713-02-29 BCpreviously failed with
day out of range.datecould already scan them.- Years past 9999 can now be scanned.
10000-01-02 03:04:05previously failed to parse, sotimestampand
timestamptzvalues at the high end of PostgreSQL's range were unreadable over the simple protocol and in any
other text-format result. time.Timearguments in the simple protocol now encode BC dates correctly, using the same timestamp encoder.- Fractional seconds beyond microsecond precision are rounded the way the server rounds them (round half to even,
carrying into the rest of the value) instead of being kept at full precision. PostgreSQL never sends more than six
fractional digits, so this only affects values from other sources.
Behavior changes:
datenow rejects impossible dates instead of normalizing them.2024-02-30returned2024-03-01and
2024-13-01returned2025-01-01; both are now errors.timestampandtimestamptzalready rejected them.- All three types now reject values outside PostgreSQL's range for that type, in the binary format as well as the
text format. PostgreSQL never sends out-of-range dates, so this only affects corrupt or hand-built input; the range
is checked in both formats so that whether a value is accepted does not depend onQueryExecMode.
timestamptzalso rejects time zone displacements outside PostgreSQL's signed 32-bit seconds range, while accepting
the wider offsets emitted for POSIX time zones, such as+16. timestamptzvalues scanned from the text format are now returned intime.Local, or inScanLocationwhen it is
set, matching what the binary format has always returned. Previously the text path kept whatever location
time.Parsederived from the offset the server sent, so the same value scanned in the two formats could report a
differentLocation()andZone(). The instant is unchanged, but everything that renders the location changes
with it:Timestamptz.MarshalJSONnow writes the client's offset rather than the server's, so a value the server
sent as+05:30marshals as2024-01-01T13:34:05-08:00on a UTC-8 client instead of2024-01-02T03:04:05+05:30,
andDecodeDatabaseSQLValuehandsdatabase/sqlatime.Timein that same location. Set the codec's
ScanLocationtotime.UTCto pin the location regardless of the client's zone.- Error messages from these paths have changed.
-
pgconn: connection URIs (
postgres://...) are now parsed by a new parser designed to exactly match libpq's URI
parser behavior instead ofnet/url,
making pgx accept and reject exactly the same URIs as libpq (verified by differential fuzzing against libpq itself).
Most connection strings are unaffected. Edge-case behavior changes, all matching libpq:+in query values is literal, no longer decoded as a space.- Malformed percent-encoding is a parse error instead of the parameter being silently dropped.
%00is rejected. - Leading/trailing spaces in URI components are trimmed; interior spaces are a parse error (encode them as
%20). #is ordinary data, not a fragment delimiter.- The userinfo terminator is the first
@before any/(previously the last@). - When a query parameter is repeated, the last occurrence wins (previously the first).
ssl=trueis accepted as an alias forsslmode=requirein URIs (JDBC compatibility). A repeatedsslkey
follows the same last-occurrence-wins rule as other repeated parameters, even across the rewrite tosslmode. If
the finalsslvalue is nottrue, an independent explicitsslmoderemains in effect.- Multiple hosts with mixed port specs are positionally aligned:
postgres://h1,h2:5433/dbnow means h1:5432 and
h2:5433 (previously both hosts got port 5433). A port list that is neither a single port nor exactly one port per
host is an error (could not match N port numbers to M hosts), also for keyword/value connection strings. - An IPv6 address in a URI must be enclosed in brackets. A bare
postgres://::1/dbwas previously accepted as host
::1; it is now read as an empty host followed by port:1and fails with an invalid port error. Write it as
postgres://[::1]/db. - Empty host list elements (e.g.
h1,,h2) get the default host instead of being dropped. Likewise, an empty host in
a keyword/value string (host=) now means the default host -- typically the Unix socket directory -- where it
previously meant a TCP connection to an empty hostname. - An empty port (
?port=in a URI orport=in a keyword/value string) now means the default port 5432 for the
affected hosts; previously it was an invalid port error. Like any connection-string port, a present-but-empty port
takes precedence overPGPORT. - ASCII control characters (tab, newline, ...) in a URI are ordinary data bytes, as they are to libpq;
net/url
rejected any URI containing one. The exception is a literal NUL byte, which is still rejected, asnet/urldid.
(libpq never sees one -- C strings end at the first NUL -- but in Go a raw NUL could otherwise pass through into
the NUL-delimited startup message and inject extra parameters.)
Unlike libpq, unrecognized URI query parameters are still accepted (they become runtime parameters or pgx-specific
options). Parse error messages avoid quoting the unredacted connection string and redact recognizable password
fields on a best-effort basis. Invalid connection strings can be structurally ambiguous, so password redaction
cannot be guaranteed for every malformed input. -
pgconn: keyword/value connection strings (
host=... user=...) now match libpq's parser exactly, the same treatment
the URI parser received above and verified the same way, by differential fuzzing against libpq itself. Most
connection strings are unaffected. Behavior changes, all matching libpq:- A backslash escapes whatever character follows it and is dropped, where previously only
\\and\'were
unescaped and every other backslash was kept. A value containing a backslash must now escape it, as libpq
requires:sslcert=C:\path\to\certreads asC:pathtocertand has to be writtensslcert=C:\\path\\to\\cert.
This mainly affects Windows certificate and key paths, which previously came through intact without doubling. - A trailing backslash in an unquoted value escapes the end of the string, so it is dropped and the value ends
there; it was previously rejected withinvalid backslash. Inside a quoted value the escaped terminator leaves
the string unterminated, which is still an error. - Whitespace inside a keyword is an error (
missing "=" after "us" in connection info string) instead of becoming
part of the key. Whitespace around the=is unaffected. This most often shows up with an unquoted value
containing a space:application_name=my app host=xpreviously set neither parameter and sentapp hostto the
server as a runtime parameter, and now fails to parse.
As with URIs, unrecognized ...
- A backslash escapes whatever character follows it and is dropped, where previously only