opencypher library

Core Cypher APIs for parsing, formatting, diagnostics, AST access, and in-memory execution.

This library exposes the lower-level API surface used by package:cypher_dart/cypher_dart.dart.

Classes

CallClause
A CALL clause.
CreateClause
A CREATE clause.
Cypher
Entry point for parsing Cypher queries.
CypherClause
A base node type for Cypher clauses.
CypherDiagnostic
A parser or validation diagnostic with location metadata.
CypherDocument
A parsed Cypher document containing one or more statements.
CypherEngine
Executes parsed Cypher query statements against InMemoryGraphStore.
CypherExecutionOptions
Options for CypherEngine.execute.
CypherExecutionResult
The result of parsing and executing a Cypher query.
CypherGraphNode
An immutable graph node value used by InMemoryGraphStore.
CypherGraphPath
A path value containing ordered nodes and relationships.
CypherGraphRelationship
An immutable graph relationship value used by InMemoryGraphStore.
CypherNode
A base node type for all Cypher AST nodes.
CypherNodeVisitor<T>
A visitor interface for traversing Cypher AST nodes.
CypherParseOptions
Configuration for Cypher.parse.
CypherParseResult
The result of parsing a Cypher query.
CypherPrinter
Formats parsed Cypher AST nodes into canonical query text.
CypherQueryStatement
A query statement composed of an ordered list of clauses.
CypherStatement
A top-level Cypher statement node.
DeleteClause
A DELETE or DETACH DELETE clause.
InMemoryGraphStore
An in-memory graph store used by CypherEngine.execute.
LimitClause
A LIMIT clause.
MatchClause
A MATCH or OPTIONAL MATCH clause.
MergeClause
A MERGE clause.
OrderByClause
An ORDER BY clause.
RemoveClause
A REMOVE clause.
ReturnClause
A RETURN clause.
SetClause
A SET clause.
SkipClause
A SKIP clause.
UnionClause
A UNION or UNION ALL clause separating query parts.
UnwindClause
An UNWIND clause.
WhereClause
A WHERE clause.
WithClause
A WITH clause.

Enums

CypherDialect
The parser behavior profile used while parsing Cypher text.
CypherFeature
Optional syntax extensions that can be enabled in strict mode.
DiagnosticSeverity
The severity level for a CypherDiagnostic.

Functions

cypherNodeToJson(CypherNode node) → Map<String, Object?>
Converts node into a JSON-serializable map.