Expand description
The GQL dialect of SurrealQL.
Lexer, parser and AST for GQL queries, and the lowering that turns a
parsed query into a PreparedGqlQuery — the LogicalOp::Match operator
the engine runs, whose scalars are the logical plan’s
LogicalExpr.
This crate is an internal implementation detail of SurrealDB: its API is
unstable and changes without notice. Depend on the surrealdb SDK or
surrealdb-core instead.
Re-exports§
pub use self::lower::PreparedGqlQuery;
Modules§
- ast
- The GQL abstract syntax tree.
- expr
- The type definitions for the computation format of the surreaql executor.
- lexer
- The GQL lexer.
- lower
- Lowering of the GQL AST onto the declarative
MatchPlanIR. - parser
- The GQL parser.
- token
- Module specifying the token representation of the GQL parser.
- val
Structs§
- GqlParser
Settings - Settings which control the behaviour of the GQL parser.
Functions§
- lower
- Lowers a parsed GQL query into a
PreparedGqlQuery(the declarativeMatchPlancarried by aLogicalOp::Match;doc/gql/V2_DESIGN.md§8). - parse_
str - Parses a GQL query with the default parser settings.
- parse_
to_ plan_ with_ settings - Parses a GQL query and lowers it into a
PreparedGqlQuery, with the given parser settings. - parse_
with_ settings - Parses a GQL query with the given parser settings.