Package stdlib

db, err := sql.Open("pgx", "postgres://pgx_md5:secret@localhost:5432/pgx_test?sslmode=disable")
if err != nil {
  return err
}

db, err := sql.Open("pgx", "user=postgres password=secret host=localhost port=5432 database=pgx_test sslmode=disable")
if err != nil {
  return err
}

pool, err := pgxpool.New(context.Background(), os.Getenv("DATABASE_URL"))
if err != nil {
  return err
}

db := stdlib.OpenDBFromPool(pool)

connConfig, _ := pgx.ParseConfig(os.Getenv("DATABASE_URL"))
connConfig.Tracer = &tracelog.TraceLog{Logger: myLogger, LogLevel: tracelog.LogLevelInfo}
connStr := stdlib.RegisterConnConfig(connConfig)
db, _ := sql.Open("pgx", connStr)

db.QueryRow("select * from users where id=$1", userID)

// Given db is a *sql.DB
conn, err := db.Conn(context.Background())
if err != nil {
  // handle error from acquiring connection from DB pool
}

err = conn.Raw(func(driverConn any) error {
  conn := driverConn.(*stdlib.Conn).Conn() // conn is a *pgx.Conn
  // Do pgx specific stuff with conn
  conn.CopyFrom(...)
  return nil
})
if err != nil {
  // handle error that occurred while using *pgx.Conn
}

m := pgtype.NewMap()
var a []int64
err := db.QueryRow("select '{1,2,3}'::bigint[]").Scan(m.SQLScanner(&a))

func GetConnector ¶

func GetConnector(config pgx.ConnConfig, opts ...OptionOpenDB) driver.Connector

func GetDefaultDriver ¶

func GetDefaultDriver() driver.Driver

GetDefaultDriver returns the driver initialized in the init function and used when the pgx driver is registered.

func GetPoolConnector ¶

func GetPoolConnector(pool *pgxpool.Pool, opts ...OptionOpenDB) driver.Connector

GetPoolConnector creates a new driver.Connector from the given *pgxpool.Pool. By using this be sure to set the maximum idle connections of the *sql.DB created with this connector to zero since they must be managed from the *pgxpool.Pool. This is required to avoid acquiring all the connections from the pgxpool and starving any direct users of the pgxpool.

func OpenDB ¶

func OpenDB(config pgx.ConnConfig, opts ...OptionOpenDB) *sql.DB

func OpenDBFromPool ¶

func OpenDBFromPool(pool *pgxpool.Pool, opts ...OptionOpenDB) *sql.DB

OpenDBFromPool creates a new *sql.DB from the given *pgxpool.Pool. Note that this method automatically sets the maximum number of idle connections in *sql.DB to zero, since they must be managed from the *pgxpool.Pool. This is required to avoid acquiring all the connections from the pgxpool and starving any direct users of the pgxpool.

func RandomizeHostOrderFunc ¶

func RandomizeHostOrderFunc(ctx context.Context, connConfig *pgx.ConnConfig) error

RandomizeHostOrderFunc is a BeforeConnect hook that randomizes the host order in the provided connConfig, so that a new host becomes primary each time. This is useful to distribute connections for multi-master databases like CockroachDB. If you use this you likely should set https://golang.org/pkg/database/sql/#DB.SetConnMaxLifetime as well to ensure that connections are periodically rebalanced across your nodes.

func RegisterConnConfig ¶

func RegisterConnConfig(c *pgx.ConnConfig) string

RegisterConnConfig registers a ConnConfig and returns the connection string to use with Open.

func UnregisterConnConfig ¶

func UnregisterConnConfig(connStr string)

UnregisterConnConfig removes the ConnConfig registration for connStr.

type Conn ¶

type Conn struct {
    // contains filtered or unexported fields
}

func (*Conn) Begin ¶

func (c *Conn) Begin() (driver.Tx, error)

func (*Conn) BeginTx ¶

func (c *Conn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error)

func (*Conn) CheckNamedValue ¶

func (c *Conn) CheckNamedValue(*driver.NamedValue) error

func (*Conn) Close ¶

func (c *Conn) Close() error

func (*Conn) Conn ¶

func (c *Conn) Conn() *pgx.Conn

Conn returns the underlying *pgx.Conn

func (*Conn) ExecContext ¶

func (c *Conn) ExecContext(ctx context.Context, query string, argsV []driver.NamedValue) (driver.Result, error)

func (*Conn) Ping ¶

func (c *Conn) Ping(ctx context.Context) error

func (*Conn) Prepare ¶

func (c *Conn) Prepare(query string) (driver.Stmt, error)

func (*Conn) PrepareContext ¶

func (c *Conn) PrepareContext(ctx context.Context, query string) (driver.Stmt, error)

func (*Conn) QueryContext ¶

func (c *Conn) QueryContext(ctx context.Context, query string, argsV []driver.NamedValue) (driver.Rows, error)

func (*Conn) ResetSession ¶

func (c *Conn) ResetSession(ctx context.Context) error

type Driver ¶

type Driver struct {
    // contains filtered or unexported fields
}

func (*Driver) Open ¶

func (d *Driver) Open(name string) (driver.Conn, error)

func (*Driver) OpenConnector ¶

func (d *Driver) OpenConnector(name string) (driver.Connector, error)

type OptionOpenDB ¶

OptionOpenDB options for configuring the driver when opening a new db pool.

type OptionOpenDB func(*connector)

func OptionAfterConnect ¶

func OptionAfterConnect(ac func(context.Context, *pgx.Conn) error) OptionOpenDB

OptionAfterConnect provides a callback for after connect. Used only if db is opened with *pgx.ConnConfig.

func OptionBeforeConnect ¶

func OptionBeforeConnect(bc func(context.Context, *pgx.ConnConfig) error) OptionOpenDB

OptionBeforeConnect provides a callback for before connect. It is passed a shallow copy of the ConnConfig that will be used to connect, so only its immediate members should be modified. Used only if db is opened with *pgx.ConnConfig.

func OptionResetSession ¶

func OptionResetSession(rs func(context.Context, *pgx.Conn) error) OptionOpenDB

OptionResetSession provides a callback that can be used to add custom logic prior to executing a query on the connection if the connection has been used before. If ResetSessionFunc returns ErrBadConn error the connection will be discarded.

type Rows ¶

type Rows struct {
    // contains filtered or unexported fields
}

func (*Rows) Close ¶

func (r *Rows) Close() error

func (*Rows) ColumnTypeDatabaseTypeName ¶

func (r *Rows) ColumnTypeDatabaseTypeName(index int) string

ColumnTypeDatabaseTypeName returns the database system type name. If the name is unknown the OID is returned.

func (*Rows) ColumnTypeLength ¶

func (r *Rows) ColumnTypeLength(index int) (int64, bool)

ColumnTypeLength returns the length of the column type if the column is a variable length type. If the column is not a variable length type ok should return false.

func (*Rows) ColumnTypePrecisionScale ¶

func (r *Rows) ColumnTypePrecisionScale(index int) (precision, scale int64, ok bool)

ColumnTypePrecisionScale should return the precision and scale for decimal types. If not applicable, ok should be false.

func (*Rows) ColumnTypeScanType ¶

func (r *Rows) ColumnTypeScanType(index int) reflect.Type

ColumnTypeScanType returns the value type that can be used to scan types into.

func (*Rows) Columns ¶

func (r *Rows) Columns() []string

func (*Rows) Next ¶

func (r *Rows) Next(dest []driver.Value) error

type Stmt ¶

type Stmt struct {
    // contains filtered or unexported fields
}

func (*Stmt) Close ¶

func (s *Stmt) Close() error

func (*Stmt) Exec ¶

func (s *Stmt) Exec(argsV []driver.Value) (driver.Result, error)

func (*Stmt) ExecContext ¶

func (s *Stmt) ExecContext(ctx context.Context, argsV []driver.NamedValue) (driver.Result, error)

func (*Stmt) NumInput ¶

func (s *Stmt) NumInput() int

func (*Stmt) Query ¶

func (s *Stmt) Query(argsV []driver.Value) (driver.Rows, error)

func (*Stmt) QueryContext ¶

func (s *Stmt) QueryContext(ctx context.Context, argsV []driver.NamedValue) (driver.Rows, error)