Skip to main content

Crate surrealdb_gql

Crate surrealdb_gql 

Source
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 MatchPlan IR.
parser
The GQL parser.
token
Module specifying the token representation of the GQL parser.
val

Structs§

GqlParserSettings
Settings which control the behaviour of the GQL parser.

Functions§

lower
Lowers a parsed GQL query into a PreparedGqlQuery (the declarative MatchPlan carried by a LogicalOp::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.