How lib/pq works
pq is a Go PostgreSQL driver for database/sql. Its main workflow is: an application supplies a DSN or Config, database/sql obtains a driver connection, and that connection negotiates a PostgreSQL session, executes statements, and returns decoded rows or errors. Separate product capabilities include bulk COPY, LISTEN/NOTIFY, authentication and TLS, and PostgreSQL-specific types. The source index and excerpts show key internal dependencies; some subsystem links below are documented by the README, while unsampled implementation details are left unconnected.
Main entry points: conn.go Database connection · proto.go Wire protocol · encode.go Value encoding · rows.go Result rows
Components 23
Driver entry
- SQL driver registration
doc.go - DSN configuration
connector.go - Connection connector
connector.go
Connection and protocol
- Database connection
conn.go - Wire protocol
internal/proto/proto.go - Statements and queries
conn.go - Result rows
rows.go
PostgreSQL features
- Bulk COPY
copy.go - Notification listener
notify.go - SCRAM authentication
internal/scram/scram.go - Kerberos integration
auth/kerberos/krb.go - TLS and certificates
ssl.go
Types and support
- Value encoding
encode.go - Password file lookup
internal/pgpass/pgpass.go - Service file lookup
internal/pgservice/pgservice.go - PostgreSQL type IDs
oid/types.go - Array values
array.go - Hstore values
hstore/hstore.go - Server errors
error.go - Error codes
pqerror/pqerror.go - Timestamp handling
internal/pqtime/pqtime.go
Other components
- Go application
- PostgreSQL server
Connections 25
- Go application → SQL driver registration: opens driver
README.md - Go application → DSN configuration: provides DSN
README.md - Go application → Connection connector: opens pool
README.md - Connection connector → Database connection: creates connection
connector.go - Database connection → PostgreSQL server: exchanges protocol
README.md - Database connection → Wire protocol: uses messages
conn.go - Database connection → Password file lookup: looks up password
conn.go - Database connection → SCRAM authentication: uses SCRAM
conn.go - DSN configuration → Service file lookup: reads service
connector.go - Statements and queries → Database connection: executes on
conn.go - Database connection → Statements and queries: prepares query
conn.go - Statements and queries → Bulk COPY: routes COPY
conn.go - Database connection → Value encoding: encodes parameters
conn.go - Value encoding → PostgreSQL type IDs: uses type IDs
encode.go - Value encoding → Timestamp handling: formats timestamps
encode.go - Result rows → Wire protocol: reads messages
rows.go - Result rows → PostgreSQL type IDs: uses type IDs
rows.go - Database connection → Result rows: returns results
conn.go - Bulk COPY → Wire protocol: uses messages
copy.go - Notification listener → Wire protocol: uses messages
notify.go - Database connection → TLS and certificates: negotiates TLS
- Database connection → Kerberos integration: supports GSS
README.md - Database connection → Server errors: parses server errors
conn.go - Server errors → Error codes: uses error codes
error.go - Go application → Notification listener: subscribes notifications
README.md