executor

Documentation

Overview

Package executor defines the specifications accessing underlying data repositories.

Index

• func WithDistributedExecutionContext(ctx context.Context, ec DistributedExecutionContext) context.Context
• func WithMeasureExecutionContext(ctx context.Context, ec MeasureExecutionContext) context.Context
• func WithStreamExecutionContext(ctx context.Context, ec StreamExecutionContext) context.Context
• type DistributedExecutionContext
  • func FromDistributedExecutionContext(ctx context.Context) DistributedExecutionContext
• type DistributedExecutionContextKey
• type ExecutionContext
• type MIterator
• type MeasureExecutable
• type MeasureExecutionContext
  • func FromMeasureExecutionContext(ctx context.Context) MeasureExecutionContext
• type MeasureExecutionContextKey
• type StreamExecutable
• type StreamExecutionContext
  • func FromStreamExecutionContext(ctx context.Context) StreamExecutionContext
• type StreamExecutionContextKey

Functions

func WithDistributedExecutionContext

func WithDistributedExecutionContext(ctx context.Context, ec DistributedExecutionContext) context.Context

WithDistributedExecutionContext returns a new context with distributed execution context.

func WithMeasureExecutionContext

func WithMeasureExecutionContext(ctx context.Context, ec MeasureExecutionContext) context.Context

WithMeasureExecutionContext returns a new context with measure execution context.

func WithStreamExecutionContext

func WithStreamExecutionContext(ctx context.Context, ec StreamExecutionContext) context.Context

WithStreamExecutionContext returns a new context with stream execution context.

Types

type DistributedExecutionContext

type DistributedExecutionContext interface {
	bus.Broadcaster
	TimeRange() *modelv1.TimeRange
}

DistributedExecutionContext allows retrieving data through the distributed module.

func FromDistributedExecutionContext

func FromDistributedExecutionContext(ctx context.Context) DistributedExecutionContext

FromDistributedExecutionContext returns the distributed execution context from context.Context.

type DistributedExecutionContextKey

type DistributedExecutionContextKey struct{}

DistributedExecutionContextKey is the key of distributed execution context in context.Context.

type ExecutionContext

type ExecutionContext interface {
	Shards(entity tsdb.Entity) ([]tsdb.Shard, error)
	Shard(id common.ShardID) (tsdb.Shard, error)
	ParseTagFamily(family string, item tsdb.Item) (*modelv1.TagFamily, error)
}

ExecutionContext allows retrieving data from tsdb.

type MIterator

type MIterator interface {
	Next() bool

	Current() []*measurev1.DataPoint

	Close() error
}

MIterator allows iterating in a measure data set.

type MeasureExecutable

type MeasureExecutable interface {
	Execute(context.Context) (MIterator, error)
}

MeasureExecutable allows querying in the measure schema.

type MeasureExecutionContext

type MeasureExecutionContext interface {
	ExecutionContext
	ParseField(name string, item tsdb.Item) (*measurev1.DataPoint_Field, error)
}

MeasureExecutionContext allows retrieving data through the measure module.

func FromMeasureExecutionContext

func FromMeasureExecutionContext(ctx context.Context) MeasureExecutionContext

FromMeasureExecutionContext returns the measure execution context from context.Context.

type MeasureExecutionContextKey

type MeasureExecutionContextKey struct{}

MeasureExecutionContextKey is the key of measure execution context in context.Context.

type StreamExecutable

type StreamExecutable interface {
	Execute(context.Context) ([]*streamv1.Element, error)
}

StreamExecutable allows querying in the stream schema.

type StreamExecutionContext

type StreamExecutionContext interface {
	ExecutionContext
	ParseElementID(item tsdb.Item) (string, error)
}

StreamExecutionContext allows retrieving data through the stream module.

func FromStreamExecutionContext

func FromStreamExecutionContext(ctx context.Context) StreamExecutionContext

FromStreamExecutionContext returns the stream execution context from context.Context.

type StreamExecutionContextKey

type StreamExecutionContextKey struct{}

StreamExecutionContextKey is the key of stream execution context in context.Context.