Skip to main content

Crate oxilite_cypher

Crate oxilite_cypher 

Source
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§

CypherJob
A Cypher statement being executed. See the module documentation.
CypherOptions
Options of the Cypher frontend.
CypherResult
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.
SqlCypherJob
A CypherJob as a core SQL Job: SPARQL parts are compiled with compile_query (no Rust fallback), so it runs on any backend, including D1 and the wasm engine.
Vocabulary
How names map to IRIs.
WriteStats
Counters of what a statement changed.

Enums§

CypherError
CypherStep
What a CypherJob needs next.
MultiValue
How a property with several RDF values is read.
SchemaCommand
A Cypher schema command about vector indexes, run by the store rather than compiled.
StepInput
The input resuming a CypherJob.
TemporalKind
Value
A Cypher value.

Constants§

RDF_JSON
rdf:JSON, the datatype of list and map property values.

Functions§

is_builtin_function
Is name a 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: query evaluates SPARQL (with the store’s fallback), sql runs requests.
schema_command
Recognizes a schema command; None for 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).

Type Aliases§

Params
Parameters of a query, by name.
Result