query

type DryRunColumn ¶ added in v0.11.475

type DryRunColumn struct {
	Name string `json:"name"`
	Type string `json:"type"`
}

DryRunColumn represents a single column in the output schema of a dry-run result.

type DryRunResult ¶ added in v0.11.475

type DryRunResult struct {
	// ConnectionType identifies the database backend (e.g., "bigquery", "snowflake", "postgres").
	ConnectionType string `json:"connectionType"`

	// Valid indicates whether the query passed validation without errors.
	Valid bool `json:"valid"`

	// BigQuery-specific fields
	TotalBytesProcessed int64          `json:"totalBytesProcessed,omitempty"`
	EstimatedCostUSD    float64        `json:"estimatedCostUSD,omitempty"`
	StatementType       string         `json:"statementType,omitempty"`
	ReferencedTables    []string       `json:"referencedTables,omitempty"`
	Schema              []DryRunColumn `json:"schema,omitempty"`

	// EXPLAIN-based databases populate this with the query plan output.
	ExplainRows *QueryResult `json:"explainRows,omitempty"`
}

DryRunResult holds the output of a dry-run operation. Different databases populate different fields depending on their capabilities.

type FileQuerySplitterExtractor ¶

type FileQuerySplitterExtractor struct {
	Fs       afero.Fs
	Renderer jinja.RendererInterface
}

FileQuerySplitterExtractor is a regular file extractor, but it splits the queries in the given file into multiple instances. For usecases that require EXPLAIN statements, such as validating Snowflake queries, it is not possible to use a single query with multiple statements, so we need to split them into multiple queries.

func (f FileQuerySplitterExtractor) CloneForAsset(ctx context.Context, p *pipeline.Pipeline, t *pipeline.Asset) (QueryExtractor, error)

func (f FileQuerySplitterExtractor) ExtractQueriesFromString(content string) ([]*Query, error)

func (f FileQuerySplitterExtractor) ReextractQueriesFromSlice(content []string) ([]string, error)

type Query ¶

type Query struct {
	VariableDefinitions []string
	Query               string
}

func (q Query) String() string

func (q Query) ToDryRunQuery() string

func (q Query) ToExplainQuery() string

type QueryDryRunner ¶ added in v0.11.475

type QueryDryRunner interface {
	DryRunQuery(ctx context.Context, q *Query) (*DryRunResult, error)
}

QueryDryRunner is an optional interface that database connections can implement to support dry-run / explain functionality for the "bruin query --dry-run" command.

type QueryExtractor ¶ added in v0.11.182

type QueryExtractor interface {
	ExtractQueriesFromString(filepath string) ([]*Query, error)
	CloneForAsset(ctx context.Context, pipeline *pipeline.Pipeline, asset *pipeline.Asset) (QueryExtractor, error)
	ReextractQueriesFromSlice(content []string) ([]string, error)
}

type QueryResult ¶ added in v0.11.53

type QueryResult struct {
	Columns     []string
	Rows        [][]interface{}
	ColumnTypes []string
}

type Renderer ¶

type Renderer struct {
	Args map[string]string
}

func (r Renderer) Render(query string) string

type WholeFileExtractor ¶

type WholeFileExtractor struct {
	Fs       afero.Fs
	Renderer jinja.RendererInterface
}

WholeFileExtractor is a regular file extractor that returns the whole file content as the query string. It is useful for cases where the whole file content can be treated as a single query, such as validating GoogleCloudPlatform queries via dry-run.

func (f *WholeFileExtractor) CloneForAsset(ctx context.Context, p *pipeline.Pipeline, t *pipeline.Asset) (QueryExtractor, error)

func (f *WholeFileExtractor) ExtractQueriesFromString(content string) ([]*Query, error)

func (f *WholeFileExtractor) ReextractQueriesFromSlice(content []string) ([]string, error)