queryresult

Documentation

Index

• type ColumnDef
  • func (c *ColumnDef) IsScalar(v any) bool
• type QueryRowSummary
  • func NewQueryRowSummary() *QueryRowSummary
  • func (s *QueryRowSummary) AsResultRow() map[string]any
  • func (s *QueryRowSummary) Update(m ScanMetadataRow)
• type Result
  • func NewResult(cols []*ColumnDef) *Result
  • func (r *Result) Close()
  • func (*Result) IsExportSourceData()
  • func (r *Result) StreamError(err error)
  • func (r *Result) StreamRow(rowResult []interface{})
• type ResultStreamer
  • func NewResultStreamer() *ResultStreamer
  • func (q *ResultStreamer) AllResultsRead()
  • func (q *ResultStreamer) Close()
  • func (q *ResultStreamer) StreamResult(result *Result)
• type RowResult
• type ScanMetadataRow
  • func NewScanMetadataRow(connection string, table string, columns []string, ...) ScanMetadataRow
  • func (m ScanMetadataRow) AsResultRow() map[string]any
• type SyncQueryResult
• type TimingResult
  • func (r *TimingResult) Initialise(summary *QueryRowSummary, scans []*ScanMetadataRow)

Types

type ColumnDef

type ColumnDef struct {
	Name     string `json:"name"`
	DataType string `json:"data_type"`
	// contains filtered or unexported fields
}

ColumnDef is a struct used to store column information from query results

func (*ColumnDef) IsScalar

func (c *ColumnDef) IsScalar(v any) bool

IsScalar checks if the given value is a scalar value it also mutates the containing ColumnDef so that it doesn't have to reflect for all values in a column

type QueryRowSummary

type QueryRowSummary struct {
	UncachedRowsFetched int64 `db:"uncached_rows_fetched" json:"uncached_rows_fetched"`
	CachedRowsFetched   int64 `db:"cached_rows_fetched" json:"cached_rows_fetched"`
	HydrateCalls        int64 `db:"hydrate_calls" json:"hydrate_calls"`
	ScanCount           int64 `db:"scan_count" json:"scan_count"`
	ConnectionCount     int64 `db:"connection_count" json:"connection_count"`
	// contains filtered or unexported fields
}

func NewQueryRowSummary

func NewQueryRowSummary() *QueryRowSummary

func (*QueryRowSummary) AsResultRow

func (s *QueryRowSummary) AsResultRow() map[string]any

func (*QueryRowSummary) Update

func (s *QueryRowSummary) Update(m ScanMetadataRow)

type Result

type Result struct {
	RowChan      *chan *RowResult
	Cols         []*ColumnDef
	TimingResult chan *TimingResult
}

func NewResult

func NewResult(cols []*ColumnDef) *Result

func (*Result) Close

func (r *Result) Close()

Close closes the row channel

func (*Result) IsExportSourceData

func (*Result) IsExportSourceData()

IsExportSourceData implements ExportSourceData

func (*Result) StreamError

func (r *Result) StreamError(err error)

func (*Result) StreamRow

func (r *Result) StreamRow(rowResult []interface{})

type ResultStreamer

type ResultStreamer struct {
	Results chan *Result
	// contains filtered or unexported fields
}

func NewResultStreamer

func NewResultStreamer() *ResultStreamer

func (*ResultStreamer) AllResultsRead

func (q *ResultStreamer) AllResultsRead()

AllResultsRead is a signal that indicates the all results have been read from the stream

func (*ResultStreamer) Close

func (q *ResultStreamer) Close()

Close closes the result stream

func (*ResultStreamer) StreamResult

func (q *ResultStreamer) StreamResult(result *Result)

StreamResult streams result on the Results channel, then waits for them to be read

type RowResult

type RowResult struct {
	Data  []interface{}
	Error error
}

type ScanMetadataRow

type ScanMetadataRow struct {
	// the fields of this struct need to be public since these are populated by pgx using RowsToStruct
	Connection   string                  `db:"connection,optional" json:"connection"`
	Table        string                  `db:"table"  json:"table"`
	CacheHit     bool                    `db:"cache_hit"  json:"cache_hit"`
	RowsFetched  int64                   `db:"rows_fetched" json:"rows_fetched"`
	HydrateCalls int64                   `db:"hydrate_calls" json:"hydrate_calls"`
	StartTime    time.Time               `db:"start_time" json:"start_time"`
	DurationMs   int64                   `db:"duration_ms" json:"duration_ms"`
	Columns      []string                `db:"columns" json:"columns"`
	Limit        *int64                  `db:"limit" json:"limit,omitempty"`
	Quals        []grpc.SerializableQual `db:"quals" json:"quals,omitempty"`
}

func NewScanMetadataRow

func NewScanMetadataRow(connection string, table string, columns []string, quals map[string]*proto.Quals, startTime time.Time, diration time.Duration, limit int64, m *proto.QueryMetadata) ScanMetadataRow

func (ScanMetadataRow) AsResultRow

func (m ScanMetadataRow) AsResultRow() map[string]any

AsResultRow returns the ScanMetadata as a map[string]interface which can be returned as a query result

type SyncQueryResult

type SyncQueryResult struct {
	Rows         []interface{}
	Cols         []*ColumnDef
	TimingResult *TimingResult
}

type TimingResult

type TimingResult struct {
	DurationMs          int64              `json:"duration_ms"`
	Scans               []*ScanMetadataRow `json:"scans"`
	ScanCount           int64              `json:"scan_count,omitempty"`
	RowsReturned        int64              `json:"rows_returned"`
	UncachedRowsFetched int64              `json:"uncached_rows_fetched"`
	CachedRowsFetched   int64              `json:"cached_rows_fetched"`
	HydrateCalls        int64              `json:"hydrate_calls"`
	ConnectionCount     int64              `json:"connection_count"`
}

func (*TimingResult) Initialise

func (r *TimingResult) Initialise(summary *QueryRowSummary, scans []*ScanMetadataRow)