Involved Source Filesauth_scram.goconfig.godefaults.go Package pgconn is a low-level PostgreSQL database driver.
pgconn provides lower level access to a PostgreSQL connection than a database/sql or pgx connection. It operates at
nearly the same level is the C library libpq.
Establishing a Connection
Use Connect to establish a connection. It accepts a connection string in URL or DSN and will read the environment for
libpq style environment variables.
Executing a Query
ExecParams and ExecPrepared execute a single query. They return readers that iterate over each row. The Read method
reads all rows into memory.
Executing Multiple Queries in a Single Round Trip
Exec and ExecBatch can execute multiple queries in a single round trip. They return readers that iterate over each query
result. The ReadAll method reads all query results into memory.
Pipeline Mode
Pipeline mode allows sending queries without having read the results of previously sent queries. It allows
control of exactly how many and when network round trips occur.
Context Support
All potentially blocking operations take a context.Context. If a context is canceled while the method is in progress the
method immediately returns. In most circumstances, this will close the underlying connection.
The CancelRequest method may be used to request the PostgreSQL server cancel an in-progress query without forcing the
client to abort.errors.gokrb5.gopgconn.go
Batch is a collection of queries that can be sent to the PostgreSQL server in a single round-trip. ExecParams appends an ExecParams command to the batch. See PgConn.ExecParams for parameter descriptions. ExecPrepared appends an ExecPrepared e command to the batch. See PgConn.ExecPrepared for parameter descriptions.
func (*PgConn).ExecBatch(ctx context.Context, batch *Batch) *MultiResultReader
BuildFrontendFunc is a function that can be used to create Frontend implementation for connection.
CloseComplete is returned by GetResults when a CloseComplete message is received.
CommandTag is the status text returned by PostgreSQL for a query. Delete is true if the command tag starts with "DELETE". Insert is true if the command tag starts with "INSERT". RowsAffected returns the number of rows affected. If the CommandTag was not
for a row affecting command (e.g. "CREATE TABLE") then it returns 0. Select is true if the command tag starts with "SELECT".( CommandTag) String() string Update is true if the command tag starts with "UPDATE".
CommandTag : github.com/ChrisTrenkamp/goxpath/tree.Result
CommandTag : fmt.Stringer
func NewCommandTag(s string) CommandTag
func (*PgConn).CopyFrom(ctx context.Context, r io.Reader, sql string) (CommandTag, error)
func (*PgConn).CopyTo(ctx context.Context, w io.Writer, sql string) (CommandTag, error)
func (*ResultReader).Close() (CommandTag, error)
func github.com/jackc/pgx/v5.ForEachRow(rows pgx.Rows, scans []any, fn func() error) (CommandTag, error)
func github.com/jackc/pgx/v5.BatchResults.Exec() (CommandTag, error)
func github.com/jackc/pgx/v5.(*Conn).Exec(ctx context.Context, sql string, arguments ...any) (CommandTag, error)
func github.com/jackc/pgx/v5.Rows.CommandTag() CommandTag
func github.com/jackc/pgx/v5.Tx.Exec(ctx context.Context, sql string, arguments ...any) (commandTag CommandTag, err error)
Config is the settings used to establish a connection to a PostgreSQL server. It must be created by [ParseConfig]. A
manually initialized Config will cause ConnectConfig to panic. AfterConnect is called after ValidateConnect. It can be used to set up the connection (e.g. Set session variables
or prepare statements). If this returns an error the connection attempt fails.BuildFrontendBuildFrontendFuncConnectTimeouttime.DurationDatabasestring // e.g. net.Dialer.DialContextFallbacks[]*FallbackConfig // host (e.g. localhost) or absolute path to unix domain socket directory (e.g. /private/tmp)KerberosSpnstringKerberosSrvNamestring // e.g. net.Resolver.LookupHost OnNotice is a callback function called when a notice response is received. OnNotification is a callback function called when a notification from the LISTEN/NOTIFY system is received.PasswordstringPortuint16 // Run-time parameters to set on connection as session default values (e.g. search_path or application_name) // nil disables TLSUserstring ValidateConnect is called during a connection attempt after a successful authentication with the PostgreSQL server.
It can be used to validate that the server is acceptable. If this returns an error the connection is closed and the next
fallback config is tried. This allows implementing high availability behavior such as libpq does with target_session_attrs. Copy returns a deep copy of the config that is safe to use and modify.
The only exception is the TLSConfig field:
according to the tls.Config docs it must not be modified after creation.
func ParseConfig(connString string) (*Config, error)
func ParseConfigWithOptions(connString string, options ParseConfigOptions) (*Config, error)
func (*Config).Copy() *Config
func ConnectConfig(octx context.Context, config *Config) (pgConn *PgConn, err error)
DialFunc is a function that can be used to connect to a PostgreSQL server.
FallbackConfig is additional settings to attempt a connection with when the primary Config fails to establish a
network connection. It is used for TLS fallback such as sslmode=prefer and high availability (HA) connections. // host (e.g. localhost) or path to unix domain socket directory (e.g. /private/tmp)Portuint16 // nil disables TLS
HijackedConn is the result of hijacking a connection.
Due to the necessary exposure of internal implementation details, it is not covered by the semantic versioning
compatibility.Config*ConfigConnnet.ConnFrontend*pgproto3.Frontend // backend pid // parameters that have been reported by the server // key to use to send a cancel query message to the serverTxStatusbyte
func (*PgConn).Hijack() (*HijackedConn, error)
func Construct(hc *HijackedConn) (*PgConn, error)
LookupFunc is a function that can be used to lookup IPs addrs from host. Optionally an ip:port combination can be
returned in order to override the connection string's port.
MultiResultReader is a reader for a command that could return multiple results such as Exec or ExecBatch. Close closes the MultiResultReader and returns the first error that occurred during the MultiResultReader's use. NextResult returns advances the MultiResultReader to the next result and returns true if a result is available. ReadAll reads all available results. Calling ReadAll is mutually exclusive with all other MultiResultReader methods. ResultReader returns the current ResultReader.
*MultiResultReader : io.Closer
func (*PgConn).Exec(ctx context.Context, sql string) *MultiResultReader
func (*PgConn).ExecBatch(ctx context.Context, batch *Batch) *MultiResultReader
NewGSSFunc creates a GSS authentication provider, for use with
RegisterGSSProvider.
func RegisterGSSProvider(newGSSArg NewGSSFunc)
NoticeHandler is a function that can handle notices received from the PostgreSQL server. Notices can be received at
any time, usually during handling of a query response. The *PgConn is provided so the handler is aware of the origin
of the notice, but it must not invoke any query method. Be aware that this is distinct from LISTEN/NOTIFY
notification.
NotificationHandler is a function that can handle notifications received from the PostgreSQL server. Notifications
can be received at any time, usually during handling of a query response. The *PgConn is provided so the handler is
aware of the origin of the notice, but it must not invoke any query method. Be aware that this is distinct from a
notice event.
ParseConfigOptions contains options that control how a config is built such as GetSSLPassword. GetSSLPassword gets the password to decrypt a SSL client certificate. This is analogous to the the libpq function
PQsetSSLKeyPassHook_OpenSSL.
func ConnectWithOptions(ctx context.Context, connString string, parseConfigOptions ParseConfigOptions) (*PgConn, error)
func ParseConfigWithOptions(connString string, options ParseConfigOptions) (*Config, error)
PgConn is a low-level PostgreSQL connection handle. It is not safe for concurrent usage. CancelRequest sends a cancel request to the PostgreSQL server. It returns an error if unable to deliver the cancel
request, but lack of an error does not ensure that the query was canceled. As specified in the documentation, there
is no way to be sure a query was canceled. See https://www.postgresql.org/docs/11/protocol-flow.html#id-1.10.5.7.9 CheckConn checks the underlying connection without writing any bytes. This is currently implemented by doing a read
with a very short deadline. This can be useful because a TCP connection can be broken such that a write will appear
to succeed even though it will never actually reach the server. Reading immediately before a write will detect this
condition. If this is done immediately before sending a query it reduces the chances a query will be sent that fails
without the client knowing whether the server received it or not.
Deprecated: CheckConn is deprecated in favor of Ping. CheckConn cannot detect all types of broken connections where
the write would still appear to succeed. Prefer Ping unless on a high latency connection. CleanupDone returns a channel that will be closed after all underlying resources have been cleaned up. A closed
connection is no longer usable, but underlying resources, in particular the net.Conn, may not have finished closing
yet. This is because certain errors such as a context cancellation require that the interrupted function call return
immediately, but the error may also cause the connection to be closed. In these cases the underlying resources are
closed asynchronously.
This is only likely to be useful to connection pools. It gives them a way avoid establishing a new connection while
an old connection is still being cleaned up and thereby exceeding the maximum pool size. Close closes a connection. It is safe to call Close on a already closed connection. Close attempts a clean close by
sending the exit message to PostgreSQL. However, this could block so ctx is available to limit the time to wait. The
underlying net.Conn.Close() will always be called regardless of any other errors. Conn returns the underlying net.Conn. This rarely necessary. If the connection will be directly used for reading or
writing then SyncConn should usually be called before Conn. CopyFrom executes the copy command sql and copies all of r to the PostgreSQL server.
Note: context cancellation will only interrupt operations on the underlying PostgreSQL network connection. Reads on r
could still block. CopyTo executes the copy command sql and copies the results to w. EscapeString escapes a string such that it can safely be interpolated into a SQL command string. It does not include
the surrounding single quotes.
The current implementation requires that standard_conforming_strings=on and client_encoding="UTF8". If these
conditions are not met an error will be returned. It is possible these restrictions will be lifted in the future. Exec executes SQL via the PostgreSQL simple query protocol. SQL may contain multiple queries. Execution is
implicitly wrapped in a transaction unless a transaction is already in progress or SQL contains transaction control
statements.
Prefer ExecParams unless executing arbitrary SQL that may contain multiple queries. ExecBatch executes all the queries in batch in a single round-trip. Execution is implicitly transactional unless a
transaction is already in progress or SQL contains transaction control statements. This is a simpler way of executing
multiple queries in a single round trip than using pipeline mode. ExecParams executes a command via the PostgreSQL extended query protocol.
sql is a SQL command string. It may only contain one query. Parameter substitution is positional using $1, $2, $3,
etc.
paramValues are the parameter values. It must be encoded in the format given by paramFormats.
paramOIDs is a slice of data type OIDs for paramValues. If paramOIDs is nil, the server will infer the data type for
all parameters. Any paramOID element that is 0 that will cause the server to infer the data type for that parameter.
ExecParams will panic if len(paramOIDs) is not 0, 1, or len(paramValues).
paramFormats is a slice of format codes determining for each paramValue column whether it is encoded in text or
binary format. If paramFormats is nil all params are text format. ExecParams will panic if
len(paramFormats) is not 0, 1, or len(paramValues).
resultFormats is a slice of format codes determining for each result column whether it is encoded in text or
binary format. If resultFormats is nil all results will be in text format.
ResultReader must be closed before PgConn can be used again. ExecPrepared enqueues the execution of a prepared statement via the PostgreSQL extended query protocol.
paramValues are the parameter values. It must be encoded in the format given by paramFormats.
paramFormats is a slice of format codes determining for each paramValue column whether it is encoded in text or
binary format. If paramFormats is nil all params are text format. ExecPrepared will panic if
len(paramFormats) is not 0, 1, or len(paramValues).
resultFormats is a slice of format codes determining for each result column whether it is encoded in text or
binary format. If resultFormats is nil all results will be in text format.
ResultReader must be closed before PgConn can be used again. Frontend returns the underlying *pgproto3.Frontend. This rarely necessary. Hijack extracts the internal connection data. pgConn must be in an idle state. SyncConn should be called immediately
before Hijack. pgConn is unusable after hijacking. Hijacking is typically only useful when using pgconn to establish
a connection, but taking complete control of the raw connection after that (e.g. a load balancer or proxy).
Due to the necessary exposure of internal implementation details, it is not covered by the semantic versioning
compatibility. IsBusy reports if the connection is busy. IsClosed reports if the connection has been closed.
CleanupDone() can be used to determine if all cleanup has been completed. PID returns the backend PID. ParameterStatus returns the value of a parameter reported by the server (e.g.
server_version). Returns an empty string for unknown parameters. Ping pings the server. This can be useful because a TCP connection can be broken such that a write will appear to
succeed even though it will never actually reach the server. Pinging immediately before sending a query reduces the
chances a query will be sent that fails without the client knowing whether the server received it or not. Prepare creates a prepared statement. If the name is empty, the anonymous prepared statement will be used. This
allows Prepare to also to describe statements without creating a server-side prepared statement. ReceiveMessage receives one wire protocol message from the PostgreSQL server. It must only be used when the
connection is not busy. e.g. It is an error to call ReceiveMessage while reading the result of a query. The messages
are still handled by the core pgconn message handling system so receiving a NotificationResponse will still trigger
the OnNotification callback.
This is a very low level method that requires deep understanding of the PostgreSQL wire protocol to use correctly.
See https://www.postgresql.org/docs/current/protocol.html. SecretKey returns the backend secret key used to send a cancel query message to the server. StartPipeline switches the connection to pipeline mode and returns a *Pipeline. In pipeline mode requests can be sent
to the server without waiting for a response. Close must be called on the returned *Pipeline to return the connection
to normal mode. While in pipeline mode, no methods that communicate with the server may be called except
CancelRequest and Close. ctx is in effect for entire life of the *Pipeline.
Prefer ExecBatch when only sending one group of queries at once. SyncConn prepares the underlying net.Conn for direct use. PgConn may internally buffer reads or use goroutines for
background IO. This means that any direct use of the underlying net.Conn may be corrupted if a read is already
buffered or a read is in progress. SyncConn drains read buffers and stops background IO. In some cases this may
require sending a ping to the server. ctx can be used to cancel this operation. This should be called before any
operation that will use the underlying net.Conn directly. e.g. Before Conn() or Hijack().
This should not be confused with the PostgreSQL protocol Sync message. TxStatus returns the current TxStatus as reported by the server in the ReadyForQuery message.
Possible return values:
'I' - idle / not in transaction
'T' - in a transaction
'E' - in a failed transaction
See https://www.postgresql.org/docs/current/protocol-message-formats.html. WaitForNotification waits for a LISTON/NOTIFY message to be received. It returns an error if a notification was not
received.
*PgConn : database/sql/driver.Pinger
func Connect(ctx context.Context, connString string) (*PgConn, error)
func ConnectConfig(octx context.Context, config *Config) (pgConn *PgConn, err error)
func ConnectWithOptions(ctx context.Context, connString string, parseConfigOptions ParseConfigOptions) (*PgConn, error)
func Construct(hc *HijackedConn) (*PgConn, error)
func github.com/jackc/pgx/v5.(*Conn).PgConn() *PgConn
func ValidateConnectTargetSessionAttrsPreferStandby(ctx context.Context, pgConn *PgConn) error
func ValidateConnectTargetSessionAttrsPrimary(ctx context.Context, pgConn *PgConn) error
func ValidateConnectTargetSessionAttrsReadOnly(ctx context.Context, pgConn *PgConn) error
func ValidateConnectTargetSessionAttrsReadWrite(ctx context.Context, pgConn *PgConn) error
func ValidateConnectTargetSessionAttrsStandby(ctx context.Context, pgConn *PgConn) error
Pipeline represents a connection in pipeline mode.
SendPrepare, SendQueryParams, and SendQueryPrepared queue requests to the server. These requests are not written until
pipeline is flushed by Flush or Sync. Sync must be called after the last request is queued. Requests between
synchronization points are implicitly transactional unless explicit transaction control statements have been issued.
The context the pipeline was started with is in effect for the entire life of the Pipeline.
For a deeper understanding of pipeline mode see the PostgreSQL documentation for the extended query protocol
(https://www.postgresql.org/docs/current/protocol-flow.html#PROTOCOL-FLOW-EXT-QUERY) and the libpq pipeline mode
(https://www.postgresql.org/docs/current/libpq-pipeline-mode.html). Close closes the pipeline and returns the connection to normal mode. Flush flushes the queued requests without establishing a synchronization point. GetResults gets the next results. If results are present, results may be a *ResultReader, *StatementDescription, or
*PipelineSync. If an ErrorResponse is received from the server, results will be nil and err will be a *PgError. If no
results are available, results and err will both be nil. SendDeallocate deallocates a prepared statement. SendPrepare is the pipeline version of *PgConn.Prepare. SendQueryParams is the pipeline version of *PgConn.QueryParams. SendQueryPrepared is the pipeline version of *PgConn.QueryPrepared. Sync establishes a synchronization point and flushes the queued requests.
*Pipeline : io.Closer
func (*PgConn).StartPipeline(ctx context.Context) *Pipeline
PipelineSync is returned by GetResults when a ReadyForQuery message is received.
ResultReader is a reader for the result of a single query. Close consumes any remaining result data and returns the command tag or
error. FieldDescriptions returns the field descriptions for the current result set. The returned slice is only valid until
the ResultReader is closed. It may return nil (for example, if the query did not return a result set or an error was
encountered.) NextRow advances the ResultReader to the next row and returns true if a row is available. Read saves the query response to a Result. Values returns the current row data. NextRow must have been previously been called. The returned [][]byte is only
valid until the next NextRow call or the ResultReader is closed.
func (*MultiResultReader).ResultReader() *ResultReader
func (*PgConn).ExecParams(ctx context.Context, sql string, paramValues [][]byte, paramOIDs []uint32, paramFormats []int16, resultFormats []int16) *ResultReader
func (*PgConn).ExecPrepared(ctx context.Context, stmtName string, paramValues [][]byte, paramFormats []int16, resultFormats []int16) *ResultReader
func github.com/jackc/pgx/v5.RowsFromResultReader(typeMap *pgtype.Map, resultReader *ResultReader) pgx.Rows
Connect establishes a connection to a PostgreSQL server using the environment and connString (in URL or DSN format)
to provide configuration. See documentation for [ParseConfig] for details. ctx can be used to cancel a connect attempt.
Connect establishes a connection to a PostgreSQL server using config. config must have been constructed with
[ParseConfig]. ctx can be used to cancel a connect attempt.
If config.Fallbacks are present they will sequentially be tried in case of error establishing network connection. An
authentication error will terminate the chain of attempts (like libpq:
https://www.postgresql.org/docs/11/libpq-connect.html#LIBPQ-MULTIPLE-HOSTS) and be returned as the error. Otherwise,
if all attempts fail the last error is returned.
Connect establishes a connection to a PostgreSQL server using the environment and connString (in URL or DSN format)
and ParseConfigOptions to provide additional configuration. See documentation for [ParseConfig] for details. ctx can be
used to cancel a connect attempt.
Construct created a PgConn from an already established connection to a PostgreSQL server. This is the inverse of
PgConn.Hijack. The connection must be in an idle state.
hc.Frontend is replaced by a new pgproto3.Frontend built by hc.Config.BuildFrontend.
Due to the necessary exposure of internal implementation details, it is not covered by the semantic versioning
compatibility.
ErrorResponseToPgError converts a wire protocol error message to a *PgError.
NetworkAddress converts a PostgreSQL host and port into network and address suitable for use with
net.Dial.
NewCommandTag makes a CommandTag from s.
ParseConfig builds a *Config from connString with similar behavior to the PostgreSQL standard C library libpq. It
uses the same defaults as libpq (e.g. port=5432) and understands most PG* environment variables. ParseConfig closely
matches the parsing behavior of libpq. connString may either be in URL format or keyword = value format (DSN style).
See https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING for details. connString also may be
empty to only read from the environment. If a password is not supplied it will attempt to read the .pgpass file.
# Example DSN
user=jack password=secret host=pg.example.com port=5432 dbname=mydb sslmode=verify-ca
# Example URL
postgres://jack:secret@pg.example.com:5432/mydb?sslmode=verify-ca
The returned *Config may be modified. However, it is strongly recommended that any configuration that can be done
through the connection string be done there. In particular the fields Host, Port, TLSConfig, and Fallbacks can be
interdependent (e.g. TLSConfig needs knowledge of the host to validate the server certificate). These fields should
not be modified individually. They should all be modified or all left unchanged.
ParseConfig supports specifying multiple hosts in similar manner to libpq. Host and port may include comma separated
values that will be tried in order. This can be used as part of a high availability system. See
https://www.postgresql.org/docs/11/libpq-connect.html#LIBPQ-MULTIPLE-HOSTS for more information.
# Example URL
postgres://jack:secret@foo.example.com:5432,bar.example.com:5432/mydb
ParseConfig currently recognizes the following environment variable and their parameter key word equivalents passed
via database URL or DSN:
PGHOST
PGPORT
PGDATABASE
PGUSER
PGPASSWORD
PGPASSFILE
PGSERVICE
PGSERVICEFILE
PGSSLMODE
PGSSLCERT
PGSSLKEY
PGSSLROOTCERT
PGSSLPASSWORD
PGAPPNAME
PGCONNECT_TIMEOUT
PGTARGETSESSIONATTRS
See http://www.postgresql.org/docs/11/static/libpq-envars.html for details on the meaning of environment variables.
See https://www.postgresql.org/docs/11/libpq-connect.html#LIBPQ-PARAMKEYWORDS for parameter key word names. They are
usually but not always the environment variable name downcased and without the "PG" prefix.
Important Security Notes:
ParseConfig tries to match libpq behavior with regard to PGSSLMODE. This includes defaulting to "prefer" behavior if
not set.
See http://www.postgresql.org/docs/11/static/libpq-ssl.html#LIBPQ-SSL-PROTECTION for details on what level of
security each sslmode provides.
The sslmode "prefer" (the default), sslmode "allow", and multiple hosts are implemented via the Fallbacks field of
the Config struct. If TLSConfig is manually changed it will not affect the fallbacks. For example, in the case of
sslmode "prefer" this means it will first try the main Config settings which use TLS, then it will try the fallback
which does not use TLS. This can lead to an unexpected unencrypted connection if the main TLS config is manually
changed later but the unencrypted fallback is present. Ensure there are no stale fallbacks when manually setting
TLSConfig.
Other known differences with libpq:
When multiple hosts are specified, libpq allows them to have different passwords set via the .pgpass file. pgconn
does not.
In addition, ParseConfig accepts the following options:
- servicefile.
libpq only reads servicefile from the PGSERVICEFILE environment variable. ParseConfig accepts servicefile as a
part of the connection string.
ParseConfigWithOptions builds a *Config from connString and options with similar behavior to the PostgreSQL standard
C library libpq. options contains settings that cannot be specified in a connString such as providing a function to
get the SSL password.
RegisterGSSProvider registers a GSS authentication provider. For example, if
you need to use Kerberos to authenticate with your server, add this to your
main package:
import "github.com/otan/gopgkrb5"
func init() {
pgconn.RegisterGSSProvider(func() (pgconn.GSS, error) { return gopgkrb5.NewGSS() })
}
SafeToRetry checks if the err is guaranteed to have occurred before sending any data to the server.
Timeout checks if err was was caused by a timeout. To be specific, it is true if err was caused within pgconn by a
context.DeadlineExceeded or an implementer of net.Error where Timeout() is true.
ValidateConnectTargetSessionAttrsPreferStandby is an ValidateConnectFunc that implements libpq compatible
target_session_attrs=prefer-standby.
ValidateConnectTargetSessionAttrsPrimary is an ValidateConnectFunc that implements libpq compatible
target_session_attrs=primary.
ValidateConnectTargetSessionAttrsReadOnly is an ValidateConnectFunc that implements libpq compatible
target_session_attrs=read-only.
ValidateConnectTargetSessionAttrsReadWrite is an ValidateConnectFunc that implements libpq compatible
target_session_attrs=read-write.
ValidateConnectTargetSessionAttrsStandby is an ValidateConnectFunc that implements libpq compatible
target_session_attrs=standby.
The pages are generated with Goldsv0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.
