cirql

Documentation

Overview

Package cirql is the covered seam over the generated ANTLR parser: it turns a cirql query string into a typed ast.Pipeline and any syntax error into the ErrParse sentinel. The generated lexer/parser live in src/grammar/cirql and are never edited by hand.

Index

• Constants
• func Parse(query Query) (ast.Pipeline, error)
• type Query

Constants

const ErrParse errs.Const = "cirql: parse error"

ErrParse is returned for any lexer or parser syntax error; the wrap adds the source position and the underlying message.

Functions

func Parse

func Parse(query Query) (ast.Pipeline, error)

Parse turns a cirql query into a Pipeline AST, or ErrParse on a syntax error.

Types

type Query

type Query string

Query is the raw text of a cirql query.