Expand description
openCypher over oxilite.
Property graphs are a view of the RDF 1.2 dataset: nodes are IRIs or blank nodes, labels
are rdf:type, node properties are literal triples, relationships are triples, and a
relationship’s identity and properties live on an RDF 1.2 reifier. A Cypher statement is
parsed, lowered to SPARQL algebra (compiled to SQL by oxilite, with its planner,
reasoning and fallback), and what SQL cannot express — writes, lists, maps, collect() —
runs in Rust over the query’s rows. Writes are applied as one atomic request.
The same CypherJob drives the blocking store, the async store (Cloudflare D1) and the
wasm engine; see oxilite::Store::cypher for the usual entry point.
Modules§
- ast
- Abstract syntax of the supported openCypher subset.
- json
- JSON forms of Cypher options and parameters, shared by the JavaScript bindings.
Structs§
- Cypher
Job - A Cypher statement being executed. See the module documentation.
- Cypher
Options - Options of the Cypher frontend.
- Cypher
Result - The result of a Cypher statement.
- Node
- A node of the property graph.
- Path
- Relationship
- A relationship: an asserted triple, identified by its reifier when it has one.
- Schema
- Property shapes by target class and path.
- SqlCypher
Job - A
CypherJobas a core SQLJob: SPARQL parts are compiled withcompile_query(no Rust fallback), so it runs on any backend, including D1 and the wasm engine. - Vocabulary
- How names map to IRIs.
- Write
Stats - Counters of what a statement changed.
Enums§
- Cypher
Error - Cypher
Step - What a
CypherJobneeds next. - Multi
Value - How a property with several RDF values is read.
- Schema
Command - A Cypher schema command about vector indexes, run by the store rather than compiled.
- Step
Input - The input resuming a
CypherJob. - Temporal
Kind - Value
- A Cypher value.
Constants§
- RDF_
JSON rdf:JSON, the datatype of list and map property values.
Functions§
- is_
builtin_ function - Is
namea function Cypher defines itself (so a host function may not take it)? - parse
- Parses a Cypher query.
- prepare
- Parses and plans a statement for a native backend.
- prepare_
for - Parses and plans a statement for a backend.
- run_
blocking - Runs a job with blocking callbacks:
queryevaluates SPARQL (with the store’s fallback),sqlruns requests. - schema_
command - Recognizes a schema command;
Nonefor any other statement. - schema_
query - The SPARQL query that reads the same shapes by evaluation instead of from the index. Kept as the reference the index is checked against (see the agreement test).