composite

Documentation

Index

• func PrepareAllQueries(ctx context.Context, p preparer) error
• type Blocks
• type DBQuerier
  • func NewQuerier(conn genericConn) *DBQuerier
  • func NewQuerierConfig(conn genericConn, cfg QuerierConfig) *DBQuerier
  • func (q *DBQuerier) InsertScreenshotBlocks(ctx context.Context, screenshotID int, body string) (InsertScreenshotBlocksRow, error)
  • func (q *DBQuerier) InsertScreenshotBlocksBatch(batch genericBatch, screenshotID int, body string)
  • func (q *DBQuerier) InsertScreenshotBlocksScan(results pgx.BatchResults) (InsertScreenshotBlocksRow, error)
  • func (q *DBQuerier) SearchScreenshots(ctx context.Context, params SearchScreenshotsParams) ([]SearchScreenshotsRow, error)
  • func (q *DBQuerier) SearchScreenshotsBatch(batch genericBatch, params SearchScreenshotsParams)
  • func (q *DBQuerier) SearchScreenshotsOneCol(ctx context.Context, params SearchScreenshotsOneColParams) ([][]Blocks, error)
  • func (q *DBQuerier) SearchScreenshotsOneColBatch(batch genericBatch, params SearchScreenshotsOneColParams)
  • func (q *DBQuerier) SearchScreenshotsOneColScan(results pgx.BatchResults) ([][]Blocks, error)
  • func (q *DBQuerier) SearchScreenshotsScan(results pgx.BatchResults) ([]SearchScreenshotsRow, error)
  • func (q *DBQuerier) WithTx(tx pgx.Tx) (*DBQuerier, error)
• type InsertScreenshotBlocksRow
• type Querier
• type QuerierConfig
• type SearchScreenshotsOneColParams
• type SearchScreenshotsParams
• type SearchScreenshotsRow

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 Blocks

type Blocks struct {
	ID           int    `json:"id"`
	ScreenshotID int    `json:"screenshot_id"`
	Body         string `json:"body"`
}

Blocks represents the Postgres composite type "blocks".

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) InsertScreenshotBlocks

func (q *DBQuerier) InsertScreenshotBlocks(ctx context.Context, screenshotID int, body string) (InsertScreenshotBlocksRow, error)

InsertScreenshotBlocks implements Querier.InsertScreenshotBlocks.

func (*DBQuerier) InsertScreenshotBlocksBatch

func (q *DBQuerier) InsertScreenshotBlocksBatch(batch genericBatch, screenshotID int, body string)

InsertScreenshotBlocksBatch implements Querier.InsertScreenshotBlocksBatch.

func (*DBQuerier) InsertScreenshotBlocksScan

func (q *DBQuerier) InsertScreenshotBlocksScan(results pgx.BatchResults) (InsertScreenshotBlocksRow, error)

InsertScreenshotBlocksScan implements Querier.InsertScreenshotBlocksScan.

func (*DBQuerier) SearchScreenshots

func (q *DBQuerier) SearchScreenshots(ctx context.Context, params SearchScreenshotsParams) ([]SearchScreenshotsRow, error)

SearchScreenshots implements Querier.SearchScreenshots.

func (*DBQuerier) SearchScreenshotsBatch

func (q *DBQuerier) SearchScreenshotsBatch(batch genericBatch, params SearchScreenshotsParams)

SearchScreenshotsBatch implements Querier.SearchScreenshotsBatch.

func (*DBQuerier) SearchScreenshotsOneCol

func (q *DBQuerier) SearchScreenshotsOneCol(ctx context.Context, params SearchScreenshotsOneColParams) ([][]Blocks, error)

SearchScreenshotsOneCol implements Querier.SearchScreenshotsOneCol.

func (*DBQuerier) SearchScreenshotsOneColBatch

func (q *DBQuerier) SearchScreenshotsOneColBatch(batch genericBatch, params SearchScreenshotsOneColParams)

SearchScreenshotsOneColBatch implements Querier.SearchScreenshotsOneColBatch.

func (*DBQuerier) SearchScreenshotsOneColScan

func (q *DBQuerier) SearchScreenshotsOneColScan(results pgx.BatchResults) ([][]Blocks, error)

SearchScreenshotsOneColScan implements Querier.SearchScreenshotsOneColScan.

func (*DBQuerier) SearchScreenshotsScan

func (q *DBQuerier) SearchScreenshotsScan(results pgx.BatchResults) ([]SearchScreenshotsRow, error)

SearchScreenshotsScan implements Querier.SearchScreenshotsScan.

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 InsertScreenshotBlocksRow

type InsertScreenshotBlocksRow struct {
	ID           int    `json:"id"`
	ScreenshotID int    `json:"screenshot_id"`
	Body         string `json:"body"`
}

type Querier

type Querier interface {
	SearchScreenshots(ctx context.Context, params SearchScreenshotsParams) ([]SearchScreenshotsRow, error)
	// SearchScreenshotsBatch enqueues a SearchScreenshots query into batch to be executed
	// later by the batch.
	SearchScreenshotsBatch(batch genericBatch, params SearchScreenshotsParams)
	// SearchScreenshotsScan scans the result of an executed SearchScreenshotsBatch query.
	SearchScreenshotsScan(results pgx.BatchResults) ([]SearchScreenshotsRow, error)

	SearchScreenshotsOneCol(ctx context.Context, params SearchScreenshotsOneColParams) ([][]Blocks, error)
	// SearchScreenshotsOneColBatch enqueues a SearchScreenshotsOneCol query into batch to be executed
	// later by the batch.
	SearchScreenshotsOneColBatch(batch genericBatch, params SearchScreenshotsOneColParams)
	// SearchScreenshotsOneColScan scans the result of an executed SearchScreenshotsOneColBatch query.
	SearchScreenshotsOneColScan(results pgx.BatchResults) ([][]Blocks, error)

	InsertScreenshotBlocks(ctx context.Context, screenshotID int, body string) (InsertScreenshotBlocksRow, error)
	// InsertScreenshotBlocksBatch enqueues a InsertScreenshotBlocks query into batch to be executed
	// later by the batch.
	InsertScreenshotBlocksBatch(batch genericBatch, screenshotID int, body string)
	// InsertScreenshotBlocksScan scans the result of an executed InsertScreenshotBlocksBatch query.
	InsertScreenshotBlocksScan(results pgx.BatchResults) (InsertScreenshotBlocksRow, 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
}

type SearchScreenshotsOneColParams

type SearchScreenshotsOneColParams struct {
	Body   string
	Limit  int
	Offset int
}

type SearchScreenshotsParams

type SearchScreenshotsParams struct {
	Body   string
	Limit  int
	Offset int
}

type SearchScreenshotsRow

type SearchScreenshotsRow struct {
	ID     int      `json:"id"`
	Blocks []Blocks `json:"blocks"`
}