pgcrypto

Documentation

Index

• func PrepareAllQueries(ctx context.Context, p preparer) error
• type DBQuerier
  • func NewQuerier(conn genericConn) *DBQuerier
  • func NewQuerierConfig(conn genericConn, cfg QuerierConfig) *DBQuerier
  • func (q *DBQuerier) CreateUser(ctx context.Context, email string, password string) (pgconn.CommandTag, error)
  • func (q *DBQuerier) CreateUserBatch(batch genericBatch, email string, password string)
  • func (q *DBQuerier) CreateUserScan(results pgx.BatchResults) (pgconn.CommandTag, error)
  • func (q *DBQuerier) FindUser(ctx context.Context, email string) (FindUserRow, error)
  • func (q *DBQuerier) FindUserBatch(batch genericBatch, email string)
  • func (q *DBQuerier) FindUserScan(results pgx.BatchResults) (FindUserRow, error)
  • func (q *DBQuerier) WithTx(tx pgx.Tx) (*DBQuerier, error)
• type FindUserRow
• type Querier
• type QuerierConfig

Functions

func PrepareAllQueries

func PrepareAllQueries(ctx context.Context, p preparer) error

PrepareAllQueries executes a PREPARE statement for all pggen generated SQL queries in querier files. Typical usage is as the AfterConnect callback for pgxpool.Config

pgx will use the prepared statement if available. Calling PrepareAllQueries is an optional optimization to avoid a network round-trip the first time pgx runs a query if pgx statement caching is enabled.

Types

type DBQuerier

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

func NewQuerier

func NewQuerier(conn genericConn) *DBQuerier

NewQuerier creates a DBQuerier that implements Querier. conn is typically *pgx.Conn, pgx.Tx, or *pgxpool.Pool.

func NewQuerierConfig

func NewQuerierConfig(conn genericConn, cfg QuerierConfig) *DBQuerier

NewQuerierConfig creates a DBQuerier that implements Querier with the given config. conn is typically *pgx.Conn, pgx.Tx, or *pgxpool.Pool.

func (*DBQuerier) CreateUser

func (q *DBQuerier) CreateUser(ctx context.Context, email string, password string) (pgconn.CommandTag, error)

CreateUser implements Querier.CreateUser.

func (*DBQuerier) CreateUserBatch

func (q *DBQuerier) CreateUserBatch(batch genericBatch, email string, password string)

CreateUserBatch implements Querier.CreateUserBatch.

func (*DBQuerier) CreateUserScan

func (q *DBQuerier) CreateUserScan(results pgx.BatchResults) (pgconn.CommandTag, error)

CreateUserScan implements Querier.CreateUserScan.

func (*DBQuerier) FindUser

func (q *DBQuerier) FindUser(ctx context.Context, email string) (FindUserRow, error)

FindUser implements Querier.FindUser.

func (*DBQuerier) FindUserBatch

func (q *DBQuerier) FindUserBatch(batch genericBatch, email string)

FindUserBatch implements Querier.FindUserBatch.

func (*DBQuerier) FindUserScan

func (q *DBQuerier) FindUserScan(results pgx.BatchResults) (FindUserRow, error)

FindUserScan implements Querier.FindUserScan.

func (*DBQuerier) WithTx

func (q *DBQuerier) WithTx(tx pgx.Tx) (*DBQuerier, error)

WithTx creates a new DBQuerier that uses the transaction to run all queries.

type FindUserRow

type FindUserRow struct {
	Email string `json:"email"`
	Pass  string `json:"pass"`
}

type Querier

type Querier interface {
	CreateUser(ctx context.Context, email string, password string) (pgconn.CommandTag, error)
	// CreateUserBatch enqueues a CreateUser query into batch to be executed
	// later by the batch.
	CreateUserBatch(batch genericBatch, email string, password string)
	// CreateUserScan scans the result of an executed CreateUserBatch query.
	CreateUserScan(results pgx.BatchResults) (pgconn.CommandTag, error)

	FindUser(ctx context.Context, email string) (FindUserRow, error)
	// FindUserBatch enqueues a FindUser query into batch to be executed
	// later by the batch.
	FindUserBatch(batch genericBatch, email string)
	// FindUserScan scans the result of an executed FindUserBatch query.
	FindUserScan(results pgx.BatchResults) (FindUserRow, error)
}

Querier is a typesafe Go interface backed by SQL queries.

Methods ending with Batch enqueue a query to run later in a pgx.Batch. After calling SendBatch on pgx.Conn, pgxpool.Pool, or pgx.Tx, use the Scan methods to parse the results.

type QuerierConfig

type QuerierConfig struct {
	// DataTypes contains pgtype.Value to use for encoding and decoding instead
	// of pggen-generated pgtype.ValueTranscoder.
	//
	// If OIDs are available for an input parameter type and all of its
	// transitive dependencies, pggen will use the binary encoding format for
	// the input parameter.
	DataTypes []pgtype.DataType
}