pgx - PostgreSQL Driver and Toolkit
pgx is a pure Go driver and toolkit for PostgreSQL.
The pgx driver is a low-level, high performance interface that exposes PostgreSQL-specific features such as LISTEN /
NOTIFY and COPY. It also includes an adapter for the standard database/sql interface.
The toolkit component is a related set of packages that implement PostgreSQL functionality such as parsing the wire protocol
and type mapping between PostgreSQL and Go. These underlying packages can be used to implement alternative drivers,
proxies, load balancers, logical replication clients, etc.
Quick Start
Installation
go get github.com/jackc/pgx/v5
Example Usage
package main
import (
"context"
"fmt"
"os"
"github.com/jackc/pgx/v5"
)
func main() {
// urlExample := "postgres://username:password@localhost:5432/database_name"
conn, err := pgx.Connect(context.Background(), os.Getenv("DATABASE_URL"))
if err != nil {
fmt.Fprintf(os.Stderr, "Unable to connect to database: %v\n", err)
os.Exit(1)
}
defer conn.Close(context.Background())
var name string
var weight int64
err = conn.QueryRow(context.Background(), "select name, weight from widgets where id=$1", 42).Scan(&name, &weight)
if err != nil {
fmt.Fprintf(os.Stderr, "QueryRow failed: %v\n", err)
os.Exit(1)
}
fmt.Println(name, weight)
}
Connection Configuration
pgx.Connect and pgxpool.New accept PostgreSQL connection URLs (such as postgres://user:pass@host:5432/db?sslmode=verify-full) as well as key=value strings. See pgconn.ParseConfig and the PostgreSQL connection string documentation for supported options and environment variables.
For a step-by-step walkthrough, see the getting started guide.
Documentation
Package documentation and API reference are available on pkg.go.dev:
pgx — base PostgreSQL driverpgxpool — concurrency-safe connection poolstdlib — database/sql compatibility adapter
Features
- Support for approximately 70 different PostgreSQL types
- Automatic statement preparation and caching
- Batch queries
- Single-round trip query mode
- Full TLS connection control
- Binary format support for custom types (allows for much quicker encoding/decoding)
COPY protocol support for faster bulk data loads- Tracing and logging support
- Connection pool with after-connect hook for arbitrary connection setup
LISTEN / NOTIFY- Conversion of PostgreSQL arrays to Go slice mappings for integers, floats, and strings
hstore supportjson and jsonb support- Maps
inet and cidr PostgreSQL types to netip.Addr and netip.Prefix
- Large object support
- NULL mapping to pointer to pointer
- Supports
database/sql.Scanner and database/sql/driver.Valuer interfaces for custom types
- Notice response handling
- Simulated nested transactions with savepoints
Choosing Between the pgx and database/sql Interfaces
The pgx interface is faster. Many PostgreSQL specific features such as LISTEN / NOTIFY and COPY are not available
through the database/sql interface.
The pgx interface is recommended when:
- The application only targets PostgreSQL.
- No other libraries that require
database/sql are in use.
It is also possible to use the database/sql interface and convert a connection to the lower-level pgx interface as needed.
Development and Testing
Each checkout has its own PostgreSQL 14-18 clusters and CockroachDB node, so the whole test matrix
is available locally on macOS, on Linux, or in the included devcontainer. Only PostgreSQL 18 stays
running by default; other targets start and stop around their tests:
scripts/setup-host # native macOS (Homebrew required) or Ubuntu: host packages and mise
export PATH="$HOME/.local/bin:$PATH" # if mise was just installed
mise trust
mise install # project tools
mise run dev:init # checkout ports and certificates
mise run dev # start PostgreSQL 18 and the on-demand database supervisor
./test.sh # the suite against PostgreSQL 18
./test.sh all # every target, starting and stopping each server as needed
Host setup installs PostgreSQL 14-18 and Ruby build dependencies. It does not install project
tools or initialize the checkout; those remain separate steps above. The devcontainer already
provides the host prerequisites.
See DEVELOPMENT.md for the full setup, and
CONTRIBUTING.md for how to contribute — including how to run the tests against
a PostgreSQL server you already have, without any of the above.
Architecture
See the presentation at Golang Estonia, PGX Top to Bottom for a description of pgx architecture.
Supported Go and PostgreSQL Versions
pgx supports the same versions of Go and PostgreSQL that are supported by their respective teams. For Go that is the two most recent major releases and for PostgreSQL the major releases in the last 5 years. This means pgx supports Go 1.25 and higher and PostgreSQL 14 and higher. pgx also is tested against the latest version of CockroachDB.
Version Policy
pgx follows semantic versioning for the documented public API on stable releases. v5 is the latest stable major version.
PGX Family Libraries
pglogrepl provides functionality to act as a client for PostgreSQL logical replication.
pgmock offers the ability to create a server that mocks the PostgreSQL wire protocol. This is used internally to test pgx by purposely inducing unusual errors. pgproto3 and pgmock together provide most of the foundational tooling required to implement a PostgreSQL proxy or MitM (such as for a custom connection pooler).
tern is a stand-alone SQL migration system.
pgerrcode contains constants for the PostgreSQL error codes.
Adapters for 3rd Party Types
Adapters for 3rd Party Tracers
Adapters for 3rd Party Loggers
These adapters can be used with the tracelog package.
3rd Party Libraries with PGX Support
pgxmock is a mock library implementing pgx interfaces.
pgxmock has one and only purpose - to simulate pgx behavior in tests, without needing a real database connection.
Library for scanning data from a database into Go structs and more.
A carefully designed SQL client for making using SQL easier,
more productive, and less error-prone on Golang.
Adds GSSAPI / Kerberos authentication support.
Explicit data mapping and scanning library for Go structs and slices.
Type safe and flexible package for scanning database data into Go types.
Supports, structs, maps, slices and custom mapping functions.
Code first migration library for native pgx (no database/sql abstraction).
A database monitoring/metrics library for pgx and sqlc. Trace, log and monitor your sqlc query performance using OpenTelemetry.
Simple Golang implementation for transactional outbox pattern for PostgreSQL using jackc/pgx driver.
Simplifies working with the pgx library, providing convenient scanning of nested structures.
Implementation of the pgx query rewriter to use ':' instead of '@' in named query parameters.
pgx 是一个用于 PostgreSQL 的纯 Go 驱动和工具包，提供底层、高性能的接口，支持 LISTEN/NOTIFY、COPY 等 PostgreSQL 专有功能，同时还提供适配标准 database/sql 接口的适配器。