Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ColumnDef ¶ added in v0.17.0
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
type QueryRowSummary ¶ added in v0.23.0
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 ¶ added in v0.23.0
func NewQueryRowSummary() *QueryRowSummary
func (*QueryRowSummary) AsResultRow ¶ added in v0.23.0
func (s *QueryRowSummary) AsResultRow() map[string]any
func (*QueryRowSummary) Update ¶ added in v0.23.0
func (s *QueryRowSummary) Update(m ScanMetadataRow)
type Result ¶
type Result struct {
RowChan *chan *RowResult
Cols []*ColumnDef
TimingResult chan *TimingResult
}
func (*Result) IsExportSourceData ¶ added in v0.17.0
func (*Result) IsExportSourceData()
IsExportSourceData implements ExportSourceData
func (*Result) StreamError ¶
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) StreamResult ¶
func (q *ResultStreamer) StreamResult(result *Result)
StreamResult streams result on the Results channel, then waits for them to be read
type ScanMetadataRow ¶ added in v0.23.0
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 ¶ added in v0.23.0
func (ScanMetadataRow) AsResultRow ¶ added in v0.23.0
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 ¶ added in v0.23.0
func (r *TimingResult) Initialise(summary *QueryRowSummary, scans []*ScanMetadataRow)
Click to show internal directories.
Click to hide internal directories.