executor

Documentation

Overview

Package executor is a generated GoMock package.

Index

• func CreateScalarSource(ID parser.NodeID, params ScalarParams, options transform.Options) (parser.Source, *transform.Controller)
• func CreateSource(ID parser.NodeID, params SourceParams, storage storage.Storage, ...) (parser.Source, *transform.Controller)
• func CreateTransform(ID parser.NodeID, params transform.Params, options transform.Options) (transform.OpNode, *transform.Controller)
• type Engine
  • func NewEngine(engineOpts EngineOptions) Engine
• type EngineOptions
  • func NewEngineOptions() EngineOptions
• type ExecutionState
  • func GenerateExecutionState(pplan plan.PhysicalPlan, storage storage.Storage, ...) (*ExecutionState, error)
  • func (s *ExecutionState) Execute(queryCtx *models.QueryContext) error
  • func (s *ExecutionState) String() string
• type MockEngine
  • func NewMockEngine(ctrl *gomock.Controller) *MockEngine
  • func (m *MockEngine) Close() error
  • func (m *MockEngine) EXPECT() *MockEngineMockRecorder
  • func (m *MockEngine) ExecuteExpr(arg0 context.Context, arg1 parser.Parser, arg2 *QueryOptions, ...) (block.Block, error)
  • func (m *MockEngine) ExecuteProm(arg0 context.Context, arg1 *storage.FetchQuery, arg2 *QueryOptions, ...) (storage.PromResult, error)
  • func (m *MockEngine) Options() EngineOptions
• type MockEngineMockRecorder
  • func (mr *MockEngineMockRecorder) Close() *gomock.Call
  • func (mr *MockEngineMockRecorder) ExecuteExpr(arg0, arg1, arg2, arg3, arg4 interface{}) *gomock.Call
  • func (mr *MockEngineMockRecorder) ExecuteProm(arg0, arg1, arg2, arg3 interface{}) *gomock.Call
  • func (mr *MockEngineMockRecorder) Options() *gomock.Call
• type QueryOptions
• type Request
• type ScalarParams
• type SourceParams
• type State
  • func (s State) String() string

Functions

func CreateScalarSource

func CreateScalarSource(
	ID parser.NodeID,
	params ScalarParams,
	options transform.Options,
) (parser.Source, *transform.Controller)

CreateScalarSource creates a scalar source node.

func CreateSource

func CreateSource(
	ID parser.NodeID,
	params SourceParams, storage storage.Storage,
	options transform.Options,
) (parser.Source, *transform.Controller)

CreateSource creates a source node.

func CreateTransform

func CreateTransform(
	ID parser.NodeID,
	params transform.Params,
	options transform.Options,
) (transform.OpNode, *transform.Controller)

CreateTransform creates a transform node which works on functions and contains state.

Types

type Engine

type Engine interface {
	// ExecuteProm runs the query and returns the result in a
	// Prometheus-compatible format (primarily used for remote read paths).
	ExecuteProm(
		ctx context.Context,
		query *storage.FetchQuery,
		opts *QueryOptions,
		fetchOpts *storage.FetchOptions,
	) (storage.PromResult, error)

	// ExecuteExpr runs the query DAG and closes the results channel once done.
	ExecuteExpr(
		ctx context.Context,
		parser parser.Parser,
		opts *QueryOptions,
		fetchOpts *storage.FetchOptions,
		params models.RequestParams,
	) (block.Block, error)

	// Options returns the currently configured options.
	Options() EngineOptions

	// Close kills all running queries and prevents new queries from being attached.
	Close() error
}

Engine executes a Query.

func NewEngine

func NewEngine(
	engineOpts EngineOptions,
) Engine

NewEngine returns a new instance of QueryExecutor.

type EngineOptions

type EngineOptions interface {
	// InstrumentOptions returns the instrument options and scope used
	// for metrics.
	InstrumentOptions() instrument.Options
	// SetInstrumentOptions sets the instrument options and scope used
	// for metrics.
	SetInstrumentOptions(instrument.Options) EngineOptions

	// GlobalEnforcer returns the query cost enforcer.
	GlobalEnforcer() qcost.ChainedEnforcer
	// SetGlobalEnforcer sets the query cost enforcer.
	SetGlobalEnforcer(qcost.ChainedEnforcer) EngineOptions

	// Store returns the storage.
	Store() storage.Storage
	// SetStore sets the storage.
	SetStore(storage.Storage) EngineOptions

	// LookbackDuration returns the query lookback duration.
	LookbackDuration() time.Duration
	// SetLookbackDuration sets the query lookback duration.
	SetLookbackDuration(time.Duration) EngineOptions

	// ParseOptions returns the parse options.
	ParseOptions() promql.ParseOptions
	// SetParseOptions sets the parse options.
	SetParseOptions(p promql.ParseOptions) EngineOptions
}

EngineOptions are used to create an engine.

func NewEngineOptions

func NewEngineOptions() EngineOptions

NewEngineOptions returns a new instance of options used to create an engine.

type ExecutionState

type ExecutionState struct {
	// contains filtered or unexported fields
}

ExecutionState represents the execution hierarchy.

func GenerateExecutionState

func GenerateExecutionState(
	pplan plan.PhysicalPlan,
	storage storage.Storage,
	fetchOpts *storage.FetchOptions,
	instrumentOpts instrument.Options,
) (*ExecutionState, error)

GenerateExecutionState creates an execution state from the physical plan.

func (*ExecutionState) Execute

func (s *ExecutionState) Execute(queryCtx *models.QueryContext) error

Execute the sources in parallel and return the first error.

func (*ExecutionState) String

func (s *ExecutionState) String() string

String representation of the state.

type MockEngine

type MockEngine struct {
	// contains filtered or unexported fields
}

MockEngine is a mock of Engine interface

func NewMockEngine

func NewMockEngine(ctrl *gomock.Controller) *MockEngine

NewMockEngine creates a new mock instance

func (*MockEngine) Close

func (m *MockEngine) Close() error

Close mocks base method

func (*MockEngine) EXPECT

func (m *MockEngine) EXPECT() *MockEngineMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockEngine) ExecuteExpr

func (m *MockEngine) ExecuteExpr(arg0 context.Context, arg1 parser.Parser, arg2 *QueryOptions, arg3 *storage.FetchOptions, arg4 models.RequestParams) (block.Block, error)

ExecuteExpr mocks base method

func (*MockEngine) ExecuteProm

func (m *MockEngine) ExecuteProm(arg0 context.Context, arg1 *storage.FetchQuery, arg2 *QueryOptions, arg3 *storage.FetchOptions) (storage.PromResult, error)

ExecuteProm mocks base method

func (*MockEngine) Options

func (m *MockEngine) Options() EngineOptions

Options mocks base method

type MockEngineMockRecorder

type MockEngineMockRecorder struct {
	// contains filtered or unexported fields
}

MockEngineMockRecorder is the mock recorder for MockEngine

func (*MockEngineMockRecorder) Close

func (mr *MockEngineMockRecorder) Close() *gomock.Call

Close indicates an expected call of Close

func (*MockEngineMockRecorder) ExecuteExpr

func (mr *MockEngineMockRecorder) ExecuteExpr(arg0, arg1, arg2, arg3, arg4 interface{}) *gomock.Call

ExecuteExpr indicates an expected call of ExecuteExpr

func (*MockEngineMockRecorder) ExecuteProm

func (mr *MockEngineMockRecorder) ExecuteProm(arg0, arg1, arg2, arg3 interface{}) *gomock.Call

ExecuteProm indicates an expected call of ExecuteProm

func (*MockEngineMockRecorder) Options

func (mr *MockEngineMockRecorder) Options() *gomock.Call

Options indicates an expected call of Options

type QueryOptions

type QueryOptions struct {
	QueryContextOptions models.QueryContextOptions
}

QueryOptions can be used to pass custom flags to engine.

type Request

type Request struct {
	// contains filtered or unexported fields
}

Request represents a single request.

type ScalarParams

type ScalarParams interface {
	parser.Params
	Node(ctrl *transform.Controller, opts transform.Options) parser.Source
}

ScalarParams are defined by sources.

type SourceParams

type SourceParams interface {
	parser.Params
	Node(ctrl *transform.Controller, storage storage.Storage,
		opts transform.Options) parser.Source
}

SourceParams are defined by sources.

type State

type State int

State is the request state.

func (State) String

func (s State) String() string