Skip to content

Virtual Cypher: reference

Spec version: 0.2.0

Status: normative. This document defines what a Virtual Cypher query means, what it guarantees, and what it refuses. It states OBSERVABLE behaviour only — never how the engine is built. Where an implementation and this document disagree, this document is the defect report. Scope. Accessibility is per PRINCIPAL and focus is per WORLD: a world decides which capabilities exist in it, not which of its owner’s data may be seen. Between principals the boundary is absolute. §15 states this in full; in particular, worlds are not mutually confidential for one owner.

Relationship to Cypher. Virtual Cypher is not a new language. A query is ordinary Cypher, and everything the openCypher specification says about pattern matching, WHERE, WITH, aggregation and ordering holds unchanged. This document specifies only the additions: labels whose rows are fetched on demand rather than stored, the declarations that make such a label reachable, the functions that reduce or judge rows with a model, and the conditions under which a query is rejected before it runs. Anything not stated here behaves as plain Cypher.

Companions. Teaching material and worked examples are in VIRTUAL_CYPHER_GUIDE.md; a one-page summary is VIRTUAL_CYPHER_CHEATSHEET.html. The declarative surface a realm author writes is described in README.md.