mirror of
https://github.com/ModernRelay/omnigraph.git
synced 2026-06-09 01:35:18 +02:00
a335d98854
Splits the 990-line AGENTS.md into a 184-line map (architecture, where-to-find index, always-on invariants, capability matrix, maintenance contract) plus 18 new docs/*.md files holding the deep content per topic (storage, schema and query languages, indexes, embeddings, branches/commits, runs, merge, changes, execution, policy, server, CLI reference, audit, errors, CI, constants, v0.3.1 notes). Adds scripts/check-agents-md.sh and a check_agents_md CI job that verifies every docs/ link in AGENTS.md resolves and every doc in the canonical set is linked. CLAUDE.md remains a symlink to AGENTS.md. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
103 lines
4.1 KiB
Markdown
103 lines
4.1 KiB
Markdown
# Query Language (`.gq`)
|
|
|
|
Pest grammar at `crates/omnigraph-compiler/src/query/query.pest`. AST in `query/ast.rs`. Type checker in `query/typecheck.rs`. Lowering in `ir/lower.rs`.
|
|
|
|
## Query declarations
|
|
|
|
```
|
|
query <name>($p1: T1, $p2: T2?, …)
|
|
@description("…") @instruction("…") {
|
|
…
|
|
}
|
|
```
|
|
|
|
Two body shapes:
|
|
|
|
- **Read**: `match { … } return { … } [order { … }] [limit N]`
|
|
- **Mutation**: one or more of `insert | update | delete` statements
|
|
|
|
Param types reuse all schema scalars; trailing `?` makes a param optional. The compiler reserves `$__nanograph_now` for `now()`.
|
|
|
|
## MATCH clauses
|
|
|
|
- **Binding**: `$x: NodeType { prop: <literal | $param | now()>, … }`
|
|
- **Traversal**: `$src EDGE_NAME { min, max? } $dst` — variable-length paths via hop bounds; default 1..1 if bounds omitted.
|
|
- **Filter**: `<expr> <op> <expr>` with operators `>=`, `<=`, `!=`, `>`, `<`, `=`, and string `contains`.
|
|
- **Negation**: `not { clause+ }` — desugars to anti-join over the inner pipeline.
|
|
|
|
## Search clauses (multi-modal)
|
|
|
|
Used inside MATCH or as expressions inside RETURN/ORDER:
|
|
|
|
| Function | Purpose | Underlying Lance facility |
|
|
|---|---|---|
|
|
| `nearest($x.vec, $q)` | k-NN vector search (cosine) | Lance vector index (IVF / HNSW) |
|
|
| `search(field, q)` | Generic FTS | Inverted index |
|
|
| `fuzzy(field, q [, max_edits])` | Levenshtein-tolerant text search | Inverted index |
|
|
| `match_text(field, q)` | Pattern match | Inverted index |
|
|
| `bm25(field, q)` | BM25 scoring | Inverted index |
|
|
| `rrf(rank_a, rank_b [, k])` | Reciprocal Rank Fusion of two rankings (default k=60) | OmniGraph fuses scored rankings |
|
|
|
|
`nearest()` requires a `LIMIT`; the compiler resolves the query vector via the param map (or via the runtime embedding client when bound to a text input).
|
|
|
|
## RETURN clause
|
|
|
|
`return { <expr> [as <alias>], … }` with expressions:
|
|
|
|
- Variable / property access: `$x`, `$x.prop`
|
|
- Literals: string, int, float, bool, list
|
|
- `now()`
|
|
- Aggregates: `count`, `sum`, `avg`, `min`, `max`
|
|
- All search functions above (so you can return a score column)
|
|
- `AliasRef` — re-use a previous projection alias
|
|
|
|
## ORDER & LIMIT
|
|
|
|
- `order { <expr> [asc|desc], … }` — supports plain expressions and `nearest(...)`.
|
|
- `limit <integer>` — required when there is a `nearest(...)` ordering.
|
|
|
|
## Mutation statements
|
|
|
|
- `insert <Type> { prop: <value>, … }`
|
|
- `update <Type> set { prop: <value>, … } where <prop> <op> <value>`
|
|
- `delete <Type> where <prop> <op> <value>`
|
|
|
|
`<value>` is a literal, `$param`, or `now()`. Multi-statement mutations execute atomically (added in v0.2.0).
|
|
|
|
## IR (Intermediate Representation)
|
|
|
|
`QueryIR { name, params, pipeline: Vec<IROp>, return_exprs, order_by, limit }`
|
|
|
|
Pipeline operations:
|
|
|
|
- `NodeScan { variable, type_name, filters }`
|
|
- `Expand { src_var, dst_var, edge_type, direction (Out|In), dst_type, min_hops, max_hops, dst_filters }` — destination filters are pushed *into* the expand so Lance scalar pushdown can prune.
|
|
- `Filter { left, op, right }`
|
|
- `AntiJoin { outer_var, inner: Vec<IROp> }` — for `not { … }`
|
|
|
|
Lowering:
|
|
|
|
1. Partition MATCH clauses (bindings, traversals, filters, negations).
|
|
2. Identify "deferred" bindings (a destination of a traversal that has filters) so the Expand can carry the filter as a pushdown.
|
|
3. Emit NodeScan for the first binding, then Expand operations, then remaining Filter operations, then AntiJoins for negations.
|
|
4. Translate RETURN / ORDER expressions; preserve LIMIT.
|
|
|
|
## Linting & validation (`query/lint.rs`)
|
|
|
|
Codes seen so far:
|
|
|
|
- **Q000** (Error): parse error
|
|
- **L201** (Warning): nullable property never set by any UPDATE — "{type}.{prop} exists in schema but no update query sets it"
|
|
- (Warning): mutation declares no params — hardcoded mutations are easy to miss
|
|
- Plus all type errors from `typecheck_query_decl()` (undefined types, mismatched operators, undefined edges, etc.)
|
|
|
|
Output:
|
|
|
|
```
|
|
QueryLintOutput { status, schema_source, query_path,
|
|
queries_processed, errors, warnings, infos,
|
|
results: [{ name, kind, status, error?, warnings[] }],
|
|
findings: [{ severity, code, message, type_name?, property?, query_names[] }] }
|
|
```
|
|
|
|
CLI exits non-zero only on `status = Error`.
|