Skip to main content

Module ast

Module ast 

Source
Expand description

Abstract Syntax Tree (AST) types for Cypher queries.

Structs§

AlterTable
ALTER TABLE statement.
AnalyzeStatement
ANALYZE statement — collect table statistics.
AttachDatabase
ATTACH DATABASE statement.
CaseAlternative
A single WHEN … THEN … branch inside a CASE expression.
CaseExpr
A CASE expression (simple or searched).
ColumnDef
CommentOnTable
COMMENT ON TABLE name IS ‘string’ — add a comment to a table.
CopyFrom
COPY FROM statement — load data from a file into a table.
CopyTo
COPY TO statement — export query results to a file.
CreateClause
CreateFtsIndex
CREATE FTS INDEX statement.
CreateGraph
CREATE [PROJECTION] GRAPH name [ANY] — create a projected graph.
CreateIndex
A CREATE [ART|HASH] INDEX statement.
CreateMacro
CREATE MACRO statement — defines a Cypher scalar macro.
CreateNodeTable
CreateRelTable
CreateSequence
CREATE SEQUENCE statement — creates a sequence for auto-incrementing counters.
CreateType
CREATE TYPE name AS type — user-defined type alias.
CreateVectorIndex
CREATE VECTOR INDEX statement — creates an HNSW index on a vector column.
DeleteClause
DetachDatabase
DETACH DATABASE statement.
DropGraph
DROP GRAPH name — remove a projected graph.
DropIndex
A DROP INDEX statement.
DropSequence
DROP SEQUENCE statement.
DropTable
EdgePattern
ExplainStatement
EXPLAIN statement wrapper.
ExportDatabase
EXPORT DATABASE statement.
ExtensionStatement
EXTENSION management statement (INSTALL/LOAD/UNINSTALL EXTENSION name).
ForeachClause
FtsQuery
A USING FTS INDEX index_name('search string') clause attached to a MATCH.
ImportDatabase
IMPORT DATABASE statement.
LoadFrom
LOAD FROM statement — scan external file without importing.
MatchClause
MergeStatement
MERGE statement — match or create a pattern with optional ON CREATE / ON MATCH actions.
NodePattern
OptionalMatchClause
OrderByItem
A single sort item in an ORDER BY clause.
Pattern
A graph pattern (node or relationship).
Query
A Cypher query (e.g., MATCH … RETURN …).
ReturnClause
ReturnItem
SetClause
SetItem
StandaloneCall
CALL statement — invoke a table function or procedure as a standalone statement.
TransactionStatement
TRANSACTION statement (BEGIN, COMMIT, ROLLBACK, CHECKPOINT).
UnionStatement
UNION statement — combines results from two queries.
UnwindClause
UseDatabase
USE DATABASE statement.
UseGraph
USE GRAPH name — set the current graph context.
WhereClause

Enums§

AlterAction
BinaryOp
Clause
A clause in a query.
Constant
CopyToFormat
EdgeDirection
ExplainType
EXPLAIN type — what kind of plan to show.
Expression
An expression in a Cypher query.
ExtensionAction
Extension management action.
Quantifier
Quantifier for list predicates.
Statement
A Cypher statement (top-level AST node).
TransactionAction
Transaction action type.
UnaryOp