The highest tagged major version is v2.

queryresult

package

v0.21.0-beta.1 Latest Latest Go to latest Published: Sep 22, 2023 License: AGPL-3.0 Imports: 2 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/turbot/steampipe

Links

Open Source Insights

Documentation ¶

Index ¶

type ColumnDef
- func (c *ColumnDef) IsScalar(v any) bool
type Result
- func NewResult(cols []*ColumnDef) *Result
type ResultStreamer
- func NewResultStreamer() *ResultStreamer
type RowResult
type SyncQueryResult
type TimingMetadata
type TimingResult

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

func (*ColumnDef) IsScalar ¶ added in v0.19.0

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 Result ¶

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

func NewResult ¶ added in v0.17.0

func NewResult(cols []*ColumnDef) *Result

func (*Result) Close ¶

func (r *Result) Close()

Close closes the row channel

func (*Result) IsExportSourceData ¶ added in v0.17.0

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 SyncQueryResult ¶

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

type TimingMetadata ¶

type TimingMetadata struct {
	RowsFetched       int64
	CachedRowsFetched int64
	HydrateCalls      int64
}

type TimingResult ¶

type TimingResult struct {
	Duration time.Duration
	Metadata *TimingMetadata
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL