flux

Documentation

Index

• Constants
• func ErrFluxSemantics(rule string) error
• func ErrFluxSyntax(token, rule string) error
• type ConstStatement
  • func (stmt *ConstStatement) Kind() StatementKind
  • func (stmt *ConstStatement) String() string
• type FluxSemanticsError
  • func (err *FluxSemanticsError) Error() string
• type FluxSyntaxError
  • func (err *FluxSyntaxError) Error() string
• type InvalidTimeFormatError
  • func ErrInvalidTimeFormat(relativeDuration, absoluteTime, unixTimestamp error) *InvalidTimeFormatError
  • func (err *InvalidTimeFormatError) Error() string
• type Parser
  • func NewParser(reader io.Reader) *Parser
  • func (p *Parser) ParseQuery() (*Query, bool, error)
• type Query
  • func (q *Query) SetExtent(ext timeseries.Extent)
  • func (q *Query) String() string
• type RangeStatement
  • func (stmt *RangeStatement) Kind() StatementKind
  • func (stmt *RangeStatement) String() string
• type Statement
• type StatementKind

Constants

const (
	// ConstStatements are any statements that Trickster doesn't care about modifying.
	// This is most statements.
	Const = StatementKind(iota)
	// RangeStatements are the range(...) contained in the query.
	Range
)

Functions

func ErrFluxSemantics

func ErrFluxSemantics(rule string) error

func ErrFluxSyntax

func ErrFluxSyntax(token, rule string) error

Types

type ConstStatement

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

func (*ConstStatement) Kind

func (stmt *ConstStatement) Kind() StatementKind

func (*ConstStatement) String

func (stmt *ConstStatement) String() string

type FluxSemanticsError

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

func (*FluxSemanticsError) Error

func (err *FluxSemanticsError) Error() string

type FluxSyntaxError

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

func (*FluxSyntaxError) Error

func (err *FluxSyntaxError) Error() string

type InvalidTimeFormatError

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

func ErrInvalidTimeFormat

func ErrInvalidTimeFormat(relativeDuration, absoluteTime, unixTimestamp error) *InvalidTimeFormatError

func (*InvalidTimeFormatError) Error

func (err *InvalidTimeFormatError) Error() string

type Parser

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

func NewParser

func NewParser(reader io.Reader) *Parser

func (*Parser) ParseQuery

func (p *Parser) ParseQuery() (*Query, bool, error)

Parse a Flux query. Returns the query and an error, plus a bool indicating if the query can use the OPC or not. A 'true' value should be taken as the error being for Trickster (no timestep), but not necessarily for InfluxDB.

type Query

type Query struct {
	Extent timeseries.Extent
	Step   time.Duration
	// contains filtered or unexported fields
}

func (*Query) SetExtent

func (q *Query) SetExtent(ext timeseries.Extent)

func (*Query) String

func (q *Query) String() string

type RangeStatement

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

func (*RangeStatement) Kind

func (stmt *RangeStatement) Kind() StatementKind

func (*RangeStatement) String

func (stmt *RangeStatement) String() string

type Statement

type Statement interface {
	// Kind() returns the StatementKind of the statement.
	Kind() StatementKind
	// String() returns a string representation of the statement.
	String() string
}

type StatementKind

type StatementKind int