Expand description
Convenience module that re-exports all public types and functions.
This module provides a single import point for all the library’s public API, including AST types, error types, lexer, parser, and token types.
Structs§
- Access
- Field access expression (e.g.,
e.data.price). - Analysis
Options - Configuration options for static analysis.
- App
- Function application (e.g.,
sum(e.price),count()). - Attrs
- Attributes attached to each expression node.
- Binary
- Binary operation (e.g.,
a + b,x == y,p AND q). - Binding
- A source binding. A name attached to a source of events.
- Expr
- An expression with metadata.
- Field
- A field in a record literal (e.g.,
{name: "Alice", age: 30}). - GroupBy
- GROUP BY clause specification
- OrderBy
- ORDER BY clause specification.
- Pos
- Position information for source code locations.
- Query
- A complete EventQL query.
- Raw
- Represents the state of a query that only has a valid syntax. There are no guarantee that all the variables exists or that the query is sound. For example, if the user is asking for an event that has field that should be a string or a number at the same time.
- Scope
- Represents a variable scope during static analysis.
- Source
- A data source in a FROM clause.
- Token
- A token with position information.
- Typed
- Represents the state of a query that has been statically analyzed.
- Unary
- Unary operation (e.g.,
-x,NOT active).
Enums§
- Analysis
Error - Errors that can occur during static analysis.
- Error
- Top-level error type for the EventQL parser.
- Lexer
Error - Errors that can occur during lexical analysis.
- Limit
- Result set limit specification.
- Operator
- Operator types for expressions.
- Order
- Sort order direction.
- Parser
Error - Errors that can occur during syntactic analysis.
- Source
Kind - The kind of data source.
- Sym
- Symbol type representing the category and value of a token.
- Symbol
- Structural symbols used in EventQL syntax.
- Type
- Type information for expressions.
- Value
- The kind of value an expression represents.
Functions§
- parse
- Parse a sequence of tokens into a Query AST.
- static_
analysis - Performs static analysis on an EventQL query.
- tokenize
- Tokenize an EventQL query string.
Type Aliases§
- Analysis
Result - Result type for static analysis operations.
- Parse
Result - Result type for parser operations.
- Text
- Type alias for text with position tracking.