@omgbase/core 0.23.0 → 0.24.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/src/mcp/reference.d.ts +1 -1
- package/dist/src/mcp/reference.js +28 -8
- package/dist/src/mutate/select.js +5 -1
- package/dist/src/oqx-js/context.js +18 -3
- package/dist/src/oqx-js/planner.js +11 -7
- package/dist/src/oqx-js/run.js +16 -1
- package/dist/src/oqx-js/sql/translate.js +12 -5
- package/dist/src/oqx-js/store-index.js +1 -1
- package/dist/src/spec-versions.d.ts +2 -2
- package/dist/src/spec-versions.js +1 -1
- package/package.json +2 -2
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const QUERY_SYNTAX = "# query \u2014 OQX syntax reference\n\nThe `query` tool takes ONE plain OQX string (+ optional `limit`/`cursor`, and\n`bare: true` to drop the automatic `id`/`path` envelope \u2014 needs a `select`).\nThere is no {from, filter, order} envelope: every concern is a clause of the\nstring. Two rules tell the two syntaxes apart: DOT navigation belongs to the\nhost object model (`doc.layer`, `section.blocks`, `dst.title`); WHITESPACE\nquery directives belong to OQX \u2014 a nested query is `<receiver> collect|exists|\ncount|first|single { <block> }` (a postfix directive + a `{ \u2026 }` block), never a\nmethod. Its distinctive power is the receiver-constrained nested query that\ncorrelates to the current row: `from docs where nodes exists { where kind ==\n\"md:task\" }` returns only the docs that themselves contain a matching node.\n\n [select <items>] from <target> [where <pred>] [frontier <pred>] [follow <dest> [{ \u2026 }], \u2026]\n [group by <key>, \u2026] [having <pred>] [order by <expr> [asc|desc], \u2026] [limit N] [offset N]\n <target> count|exists|none|first|single { <block> } (scalar/one-row form: a bare target at the root scope)\n\nCLAUSE ORDER IS FIXED: select, from, where, frontier, follow, group by, having, order by, limit, offset \u2014\neach at most once; an out-of-order clause is a parse error naming the order.\nOnly `select` may drop its keyword, and only as the first clause\n(`path, era from docs where \u2026`). A top-level predicate needs `where`, because\n`where` follows `from` (`era > 1600 from docs` is the clause-order error); a\nblock may LEAD with a predicate (see Sugar), but a predicate after a projection\nstill needs the keyword (`{ name where kind == \"md:task\" }`, not\n`{ name, kind == \"md:task\" }`); `from docs count` is an error (write\n`docs count { \u2026 }`). `where` and later `select` items may use the same body's\n`select` aliases (`select path, old: era < 1000 from docs where old`; an alias\nshadows a same-named field there). `and` / `or` / `not` are the connectives;\nthe symbols `&&` / `||` / `!` are accepted synonyms (the words are canonical and\nwhat `print` writes).\n\n## Sugar (OQX 0.17)\n\nEvery form here is shorthand for an explicit directive (the AST is the explicit form):\n nodes { kind == \"md:task\" } \u2261 nodes collect { where kind == \"md:task\" } \u2014 a receiver block with\n no consumer is collect; a block whose LEADING expression is a predicate\n (comparison, call, !/is/not, in, literal, (\u2026), a consumer test \u2014 anything\n but a bare name, a dotted path or a ^lift) is where-first. Bare names still\n project: nodes { name } \u2261 nodes collect { name }; filter a bare field with\n nodes { is checked }. Wherever a value stands (0.20), call arguments included:\n size(children { is checked }); x distinct { \u2026 } \u2261 x collect distinct { \u2026 }. After a\n follow destination too: follow children { depth 2 } is that destination's block.\n (a, b) a tuple (0.20): two or more expressions, concatenated one level flat \u2014 a value\n (size((tags, aliases)), \"x\" in (tags, aliases)) and a receiver ((a, b) { \u2026 },\n follow (before, after) { depth 2 }); (a) alone is grouping\n refs(x)[0] \u2261 refs(x) first { offset 0 } positional (integer literal or ${binding});\n out of range \u21D2 absent; refs(x)[0].path navigates the row\n ^docs[path == ^company] \u2261 ^docs first { where path == ^company } first match or absent\n ^docs[path == ^company]! \u2261 \u2026 single { \u2026 } required: exactly one, else filter_invalid\n title! required: title, or an error naming the expression (and the row's $key \u2014 its id)\n \u2014 never a filter, never a coercion (0!, \"\"! are values); tightest: a!.b vs a.b!\n is x / not x truthiness of x, and its negation (prefix; `not` \u2261 `!`)\n x is y / x is not y identity ($key: a store row's id, else structural) \u2014 compares rows, which == does not;\n x is null = absent; for scalars is \u2261 ==; comparison precedence, no chaining\n a and b / a or b the connectives (\u2261 && / ||: same precedence, short-circuit, value: data.title or path coalesces)\n boss: ^docs[path == ^manager], bossName: boss.title a select item may use the items to its LEFT\n Reserved words (never a bare field name): from where select is not and or, true false null.\n Contextual words (limit order offset follow collect count first distinct desc by in frontier depth) parse as\n fields in expression position (select o: order from docs).\n\nResults are LEAN hits \u2014 { id, path } + whatever `select` projects (or `values`,\n`count`, `exists`, `none`). The envelope keys ARE the attributes: copy a hit's\n`id` straight into `where id == \"\u2026\"` (no translation); `select id, path` is simply\nthe envelope (no duplicate columns); any OTHER projection whose output key would\nbe `id` or `path` must be aliased \u2014 `select data.path` is refused (\"projection\n`path` collides with the hit envelope \u2014 alias it (`p: data.path`)\"); a row\nsurfacing as a value (an empty `collect { }`) is the same `{ id, path }`. Every\nother tool spells a row the same way (`docs_read` \u2192 `{ id, path, rev, properties,\nraw }`, `blocks_read` \u2192 `{ id, type, text, raw, hash, \u2026 }`, `docs_list` \u2192 `{ id,\npath, updated_at, blocks }`, a revision \u2192 `{ id, path, hash }`): hydrate by id via\nblocks_read/docs_read.\n\n## Paths\n\nEvery path the surface returns is `/`-rooted \u2014 the form a reference is\nwritten in (`[x](/projects/oqx.md)`, `before: [/timeline/kickoff.md]`): a\nhit's `path`, an edge's `dst_path`, every tool's paths. Every path it\naccepts tolerates both forms (`/a.md` or `a.md`): tool arguments, `refs(x)`,\n`within(...)`, and a string LITERAL compared with `path`/`dst_path` (bare, or\nthrough a row handle: `doc.path`) by `==`/`!=` or passed to their\n`.startsWith(...)` (it is rooted first, so `path == \"a.md\"` and `path == \"/a.md\"`\nboth match). A property holding a reference compares directly \u2014 and is never\nrooted: `where ^path in list(after)`, `where customer == ^path`,\n`where data.path == \"/x.md\"` (the author's `path:` key, as written) \u2014 no\n`\"/\" + ...` glue.\n\n## Targets & field namespaces\n\nTHE NAME RULE: `$` belongs to OQX \u2014 $it, $key, $depth, $stop, $leaf, $frontier,\n$ordinal are values the LANGUAGE injects into a scope; omgbase adds NO $ names\n(a `$id` in a query is an unknown name, absent). Every engine attribute is a BARE\nsnake_case name that WINS on collision \u2014 the convention the relations (children,\nblocks, out, in, doc, frontmatter, \u2026) always followed: a bare name that is an\nengine attribute reads the engine's value, never yours. Your data is bare too;\nwhere a key of yours collides with an engine name, reach it through a source\nhandle: `data.<k>` (the merged authored view \u2014 frontmatter + inline, exactly the\nread a bare non-colliding key performs), `frontmatter.<k>`, `inline.<k>`. So\n`path` is the engine's /-rooted location and `data.path` your `path:` key;\n`tags` is your tags \u222A the body #hashtags and `data.tags` the authored list alone;\n`title` the computed title (the first H1) and `data.title` your `title:`;\n`entries(data)` lists every authored top-level key. Same value, same name\neverywhere: a hit's `id` is docs_read's `id` and the `id` argument of blocks_read.\n\n Reserved bare names per kind (engine attributes; handles; self; relations):\n docs id path raw hash updated_at title tags format | data frontmatter inline | doc | blocks nodes out_links in_links revisions\n blocks id path doc_id raw hash updated_at type text attrs depth ordinal | block doc | children nodes out_links section\n nodes id path doc_id block_id kind name value attrs | section doc block | blocks subsections children\n links id path doc_id block_id via_id dst_id dst_path uri field dst_kind predicate provenance anchor | doc\n revisions id path rev seq doc_id commit ts origin actor reason hash is_current archived | doc\n A key of yours with any of these names is `data.<k>` (or frontmatter.<k> /\n inline.<k> by source; attrs.<k> on a block or node).\n UNKNOWN NAMES: a name that is none of the above AND that no object of the\n kind in this repository carries is reported before any row is read \u2014 on\n links as a filter_invalid error naming the fields; on docs/blocks/nodes the\n result gains `hints` (one line per name, nearest match when there is one)\n and the rows still come back; in a plan/apply/execute selector it is refused.\n A property some objects carry is known (partial presence is normal).\n\ndocs:\n - bare identifier = a document PROPERTY (frontmatter + inline `key:: value`,\n unioned; nested via dots: meta.owner). YAML/JSON docs\n expose the parsed object's keys the same way.\n - source handles = data.<k> (merged authored view) / frontmatter.<k> /\n inline.<k>; the whole bag as a collection via entries(data)\n / entries(frontmatter) / entries(inline) (see entries()).\n - attributes = id, path (/-rooted, see Paths), updated_at (ISO-8601,\n sorts chronologically), raw (the whole file, frontmatter\n included), hash (its sha256, 64 hex), title (the computed\n title: the first H1; data.title is the authored key), tags\n (authored tags \u222A body #hashtags, deduped, authored first;\n data.tags is the authored list), format (the doc's format \u2014\n \"markdown\"/\"yaml\"/\"json\"; present on EVERY doc, so\n has(format) is always true and `format == \"yaml\"` is the\n filter).\n - relations = nodes, blocks, doc.out_links / doc.in_links (a doc's\n links as rows; the documents at their other end are\n out_links collect distinct { from dst } and\n in_links collect distinct { from doc } \u2014 there is no\n out / in relation), revisions (the document's stored\n revisions, oldest first \u2014 see revisions below).\n\nblocks:\n - bare fields = doc_id (the owning doc), type, text (normalized), ordinal\n (0-based among siblings), depth (0 at the top level), and\n every attrs key FLATTENED onto the row (bare `checked`\n reads attrs.checked; `attrs.<k>` still works; the\n structural fields win on collision; absent \u21D2 false).\n - attributes = id, path (the owning doc's path), raw (the block's raw\n source \u2014 a container's raw holds its children), hash\n (its sha256 \u2014 the value update/split expect as\n expect.content_hash), updated_at.\n - reach-through = doc.<key> / doc.path / doc.id / doc.format = the\n CONTAINING doc (doc.id and doc.path cost nothing \u2014 they\n read the row's own doc_id / joined path, no lookup).\n - relations = block.children, block.nodes, block.out_links, section.\n NOTE: inside a `follow`, $depth/$ordinal are ALWAYS the walk's metadata; a\n block's own nesting is `depth` / `ordinal` (no $) everywhere.\n\nnodes:\n - bare fields = doc_id, block_id (null for a block-less node), kind\n (md:task / md:link / md:section / yaml:\u2026), name, value,\n + attrs keys flattened (checked, level).\n - attributes = id, path.\n - reach-through = doc.<key> / doc.id / doc.path, block.type / block.text\n / block.id / block.path.\n - relations = section.blocks, section.children, section.subsections.\n\nlinks: (the authored link graph as rows \u2014 one per open link: the relation a link\n establishes; the md:link NODE is its occurrence in the text and via_id\n points at it \u2014 a frontmatter link has a row and no node)\n - bare fields = doc_id (the SOURCE doc), block_id (the source block; null\n for a frontmatter edge), via_id, dst_id (the destination\n node id: a doc id, an external node id or phantom:<path>),\n dst_path (target doc path, /-rooted; NULL when\n dangling/external), uri (external URL; NULL otherwise),\n predicate (\"references\"/\"embeds\"/freeform), provenance\n (\"link\"/\"frontmatter\"/\"inline_field\"/\u2026), dst_kind\n (\"document\"/\"external\"/\"collection\"), anchor, field (the\n frontmatter key / inline field it was authored in).\n - attributes = id, path (the SOURCE doc's path); doc.<key> reaches the\n source document. There is no from_commit: a query sees\n open edges only (history is blocks_history/changes_since).\n - text()/semantic() are N/A on links.\n\nrevisions: (history as rows \u2014 one per stored revision of every document of the\n repository, deleted documents included: what docs_history lists, queryable)\n - bare fields = rev (= id), seq (1, 2, \u2026 per document), doc_id, commit,\n ts (the commit's time, sorts chronologically), origin\n (\"observed\"/\"api\"/\"import\"/\"projection\"), actor, reason,\n hash (the rendered file's sha256 \u2014 docs_history's hash),\n is_current (true for the document's current revision),\n archived (true when the bodies moved to an archive segment:\n the row stays, docs_read { at } reads through the segment).\n - attributes = id (the revision id, r_\u2026), path (the path the revision\n was committed under \u2014 a move re-paths only the current\n revision, so earlier ones keep the old path). doc.<key>\n reaches the document's CURRENT row; absent for a deleted\n document, so where doc == null is the revisions of deleted documents.\n - on docs = revisions is a relation (oldest first): a document with\n more than one version is docs { revisions count { } > 1 }.\n - text()/semantic() are N/A on revisions. The body as of a revision is\n docs_read { path, at: \"<rev>\" } (docs_read_at is the same call).\n\n## Scoping (ADR-015; the root row since surface 2.0): bare names are LOCAL\n\n name the CURRENT row only \u2014 never falls through to an enclosing row\n or the repository; an absent field is simply absent.\n ^name one scope OUT (the enclosing row's fields/intrinsics/lifts);\n ^^name two scopes out. `^path` = the enclosing row's path.\n ^docs ^nodes ^blocks ^links ^revisions\n THE ROOT ROW (surface 2.0, oqx 0.18): the repository is the root\n scope's row, one scope out from a top-level row, so ^docs there is\n the whole documents scan (uncorrelated until you add a ^ predicate);\n one caret per enclosing block (^^docs from depth two), or the\n absolute 0^docs from ANY depth. ^id / 0^id = the repository id.\n ^$it = the root object: ^$it.docs \u2261 ^docs, entries(^$it) names the\n five collections. At the root scope itself a bare target is the scan\n (docs count { \u2026 }, from docs, entries(docs)).\n ERRORS: a bare `docs` INSIDE a block reads a property of the current\n row, which has none \u2014 refused (\"did you mean ^docs\"); `^docs` AT THE\n TOP LEVEL reaches past the root \u2014 refused (write the bare `docs`);\n so is `$repo` (surface < 2.0; the message names the replacement).\n nodes/blocks on a doc row are that doc's RELATIONS, not the root.\n $it the current item itself (a row, or each ELEMENT when the\n receiver is a list property); ^$it = the enclosing row.\n $value is NOT an intrinsic (since oqx 0.15): it reads a\n property literally named $value, absent when there is none.\n $key the row's identity (0.20): a store row's id (doc/block/node/edge), an entries(x)\n entry's key, a follow occurrence's walk identity; project $key: <expr> to rekey the\n rows a block yields (a destination block's $key: is not a column).\n\n## Scalar semantics (@omgbase/oqx)\n\n comparisons == != < <= > >= strict & typed (5 == \"5\" is false); either\n side may be a field (field-vs-field OK).\n absence null and a missing field are the same \"absent\" value; two absents\n are EQUAL, so `absent != \"x\"` is TRUE and `absent == null` is TRUE.\n Relational (< <= > >=) on an absent operand \u2192 FALSE. Bare `f` in\n boolean position uses JS truthiness (absent/false/0/\"\" \u21D2 false;\n NOTE: \"false\", [] and {} are truthy). has(f) = explicit presence.\n boolean and or not grouping ( \u2026 ) \u2014 && || ! are accepted synonyms\n arithmetic + - * / % (+ concatenates if either side is a string)\n membership x in y array \u2192 typed membership; string \u2192 substring;\n object \u2192 key exists; range \u2192 coverage. Any list\n property works directly: \"pricing\" in tags. list(f)\n coerces scalar-or-list (absent \u2192 []) \u2014 use it when a\n key is sometimes scalar, sometimes a list.\n ranges lo..hi (inclusive) lo...hi (exclusive hi) ..hi lo..\n era in 800..1680; works over ISO dates. range(prop) reads a\n range-shaped STRING property as an interval: \"2026-01-15\" in range(window).\n strings x.contains(\"s\") x.startsWith(\"p\") x.endsWith(\"s\") x.matches(\"^re$\")\n (real regex) x.lower() x.upper() size(x). ALL CASE-SENSITIVE \u2014\n fold with .lower(): title.lower().contains(\"aurora\").\n Infix regex: x ~ \"re\" is x.matches(\"re\"); x ~* \"re\" is the\n case-insensitive match; x !~ \"re\" and x !~* \"re\" negate them.\n Unanchored unless the pattern anchors; an absent x is false\n under ~ and TRUE under !~ (not SQL's NULL).\n functions has(f) size(x) list(x) entries(x) range(s)\n dates a date is an ISO string, a duration a NUMBER OF SECONDS; arithmetic\n is METHODS, never + or - (+ concatenates strings).\n date(\"today\"|\"now\"|\"yesterday\"|\"tomorrow\"|\"sow\"|\"eow\"|\"som\"|\"eom\"|\n \"soy\"|\"eoy\") \u2014 the host clock, UTC; date(\"2026-10-15\") canonical ISO\n (absent if unparseable). dur(\"1h30m\") dur(\"2 days, 3 hours\")\n dur(\"P1DT2H\") dur(90) \u2192 seconds (year = 365 d, month = 30 d).\n d.plus(dur(\"30 days\")) d.minus(86400) d.plus(\"1 month\") (calendar:\n Jan 31 \u2192 Feb 28) a.until(b) \u2192 signed seconds d.year() d.month()\n d.day() d.weekday() (1 = Mon) d.hour() d.minute() d.second()\n d.date() d.format(\"EEE dd MMM yyyy\") n.dur_text() \u2192 \"1h 30m\"\n n.dur_iso() \u2192 \"PT1H30M\". Total: a non-date is absent, so\n `where date(due) < date(\"today\").minus(dur(\"30 days\"))` just\n filters. A datetime is never < its own date: compare\n updated_at.date() == date(\"today\"), or < date(\"tomorrow\").\n literals \"str\" 'str' 123 1.5 true false null\n determinism no random; the only clock is date(\"today\"/\"now\"/\u2026), read once per\n query. Lists/structs are not literals; ternary is not supported.\n Errors surface as filter_invalid.\n scalars vs lists a list-authored key never == a scalar (tags == \"x\" is false\n when tags is a list) \u2014 use `\"x\" in tags` / `in list(tags)`.\n\n## Domain predicates (omgbase)\n\n text(\"terms\") FTS5 PRUNING predicate (docs match via their blocks, nodes\n via the node index); composes anywhere, incl. nested scopes.\n semantic(\"phrase\") embedding cosine SCORE (docs/blocks): threshold it\n (semantic(\"x\") > 0.6), project it, or `order by semantic(\"x\")\n desc` for top-K. Needs a provider that has embedded the repository; else provider_unavailable.\n blocks target only:\n under(id_or_heading) block in the containment subtree / section range\n under_heading(\"Launch\") an ancestor section heading contains the text (ci)\n under_kind(type[, name]) an ancestor block has that type (name: its text\n contains / its key equals name)\n within(\"path\" | \"d_..\") containing doc = id, exact path, or path glob (*);\n either path form\n yaml_path(\"a.b\") YAML docs: the block at that key path\n json_pointer(\"#/a/b\") JSON docs: the block at that pointer\n has_edge(\"pred\"[, target]) an open authored edge with that predicate leaves here\n has_anchor() block carries an authored ^ref\n parent_type() == \"x\" parent block's type (must be compared)\n child_count() > 0 number of direct children (must be compared)\n refs(x) the live documents a property's document references name:\n x is a string, a list or absent; each \"/a/b.md\", \"a/b.md\"\n or \"d_\u2026\" element resolves to that doc's row; dangling and\n non-string elements are dropped. Yields docs rows, so it is\n a source, a receiver or a follow destination:\n follow refs(before), refs(after) walks a timeline both ways.\n The reverse direction needs no function: a document's\n path is already the reference form, so\n ^docs { where ^path in list(after) } is\n \"the documents whose `after` names me\".\n A HIT IS A STORE ROW: a top-level row that is not a doc/block/node/edge fails\n (filter_invalid). `follow before` over a list of paths\n reaches the STRINGS \u2014 write `follow refs(before)`.\n\n## Nested queries & consumers\n\n <receiver> collect|exists|none|count|first|single { <block> }\n receiver = a relation (nodes, blocks, doc.out_links, section.blocks, \u2026), a\n reach-through row (dst, doc: one row \u2014 dst { title }), a\n list property (tags), entries(x), or a root collection (^docs; 0^docs at depth \u2265 2).\n block = [select \u2026] [from E] [where \u2026] [frontier \u2026] [follow \u2026] [order by \u2026] [limit N] [offset N]\n \u2014 the same fixed order as the top level (`from` optional; the\n receiver supplies the rows). A leading name/alias list is the\n projection (`select` dropped); a predicate always needs `where`.\n A `from E` inside a block RE-PROJECTS the rows through a relation\n (a typed flatMap): `docs collect { from nodes where kind == \"md:task\" }`\n starts at docs, projects each through `nodes`, and queries the\n resulting nodes; a scalar relation (`from doc`) contributes one\n row; a missing or non-navigable relation is a loud error, never a\n global scan.\n exists \u22651 row nodes exists { where kind == \"md:task\" and not checked }\n none 0 rows nodes none { where kind == \"md:task\" and not checked } (\"every task done\")\n count a number nodes count { where kind == \"md:task\" } >= 2\n collect rows (default) \u2014 in select for nested results; in where with a lift\n first / single zero-or-one (single errors on >1) \u2014 lookups in select\n distinct on any consumer: dedup by projected value \u2014 nodes count distinct { select kind }\n limit/offset bound the block's rows AFTER where/order/distinct, BEFORE the\n consumer reduces: nodes exists { offset 1 } = at least two;\n first { \u2026 offset 1 } = the second.\n lift `^name:` in a where-collect binds values outward:\n select path, open from docs where nodes collect { ^open: value where kind == \"md:task\" and not checked }\n joins ^<t> exists { where slug == ^ref } semi-join; not \u2026 exists anti-join;\n ^nodes single { where kind == \"person\" and attrs.id == ^owner_id } lookup;\n x in ^keys membership over a lifted set.\n\n## select \u2014 projection\n\n select a, alias: expr, nested: nodes collect { \u2026 }\n bare key \u2192 the attribute when it is one (id, path, title, \u2026), else the property\n (scalar-authored \u2192 scalar; list \u2192 array); data.<k> forces the property;\n a call/arithmetic needs an alias (n: size(tags)) unless in values mode;\n an output key of id/path other than the attribute itself needs an alias.\n raw whole file bytes (docs) \u2014 docs_read is cheaper for one doc.\n distinct select distinct type (dedup hits by projected value)\n values select <ONE item> values \u2192 bare values instead of records:\n select distinct type values from docs \u2192 values: [\"hub\",\"lab-note\",\u2026]\n select path values from docs \u2192 values: [\"/index.md\", \u2026]\n tags: tags collect { $it values } \u2192 a plain array\n h: nodes first { name values where kind == \"md:section\" order by first_ordinal }\n entries(x) a record as a collection ($key / $it per entry), key order:\n select fm: entries(data) collect { k: $key, v: $it }\n where entries(frontmatter) exists { where $key == \"era\" and $it > 1600 }\n entries(inline), entries(attrs), a nested map, or a list (index keys)\n $semantic_score is not a field \u2014 project semantic(\"\u2026\") under an alias instead.\n\n## order by, limit/offset, pagination\n\n order by era desc, path asc absent values sort LAST (asc); ties \u2192 (path, id)\n limit N / offset N define the result SET (integer literals);\n the tool's limit/cursor then page WITHIN it\n cursor opaque keyset on (path,id); a custom order by\n disables it (you get the top page + truncated)\n\n## Graph traversal (follow) and links\n\n The citation graph is the LINK ROWS walked through a destination block:\n dst is a link's destination document (absent for an external or dangling\n link \u2014 it then contributes no successor), doc its source.\n from docs where <seed> follow out_links collect { from dst } docs the seed links TO\n from docs where <seed> follow in_links collect { from doc } backlinks\n follow out_links collect { from dst depth 3 } bound (1..8, default 8) \u2014 a clause of the block\n follow out_links collect { from dst where layer == \"canon\" } keep only matching successors\n follow in_links collect { from doc where ^path in list(before) } ^ = the row being expanded\n (^^ = the walk's enclosing scope)\n follow out_links collect { from dst where predicate == \"depends_on\" } one predicate only\n follow out_links collect { from dst }, in_links collect { from doc }\n several destinations: their union\n (one step dedups by identity)\n follow ^docs { where out_links exists { where dst_path == ^^path } }\n a destination block over the root's\n documents, re-read per frontier row\n (^ = that row) = the backlinks walk\n follow out_links collect { from dst frontier type == \"practitioner\" } cut, keeping the frontier row\n from docs where type == \"process\" frontier !verified follow out_links collect { from dst }\n the BODY's frontier applies to the seeds:\n an unverified seed is kept, not expanded\n follow distinct out_links collect { from dst } / \u2026 { $key: group from dst } identity control ($key)\n follow refs(before), ^docs { where ^path in list(after) } forward over `before`, backward\n over every doc whose `after` names me\n Per-occurrence metadata: $depth (seed = 1), $stop (interior|leaf|frontier|\n depth|cycle), $leaf/$frontier, $ordinal (a deterministic 1..N rank over the\n walk, ordered by depth then path \u2014 `order by $ordinal` for walk order,\n `where $ordinal <= N` for a deterministic budget cut), $key \u2014 usable in\n select/order by and the top-level post-walk where (a where conjunct that\n reads one filters the walk's RESULT; the other conjuncts remain the seed\n predicate), NOT metadata of the candidates a destination block's where reads,\n nor valid inside a consumer directive. Cyclic graphs are safe: a revisited\n node is admitted once as a `$stop == \"cycle\"` occurrence and never\n re-expanded. The default keeps one occurrence per distinct walk path;\n `follow distinct` dedups reached rows by identity.\n Destination blocks (OQX 0.20): a brace after ANY destination opens that\n destination's block \u2014 children { depth 2 }, refs(x) { depth 2 }, out_links\n collect { from dst depth 2 }, ^docs { where ^path in list(after) } \u2014 with the\n 0.17 body rules (where-first, projections) and two clauses of its own after\n `where`: frontier <pred> (occurrences reached through this destination that\n match are frontiers; ^ there is the walk's enclosing scope) and depth <n>\n (this destination expands a frontier row only while $depth < n). The body\n that carries the follow may write frontier <pred> too, after its where and\n before follow: it applies to the SEEDS (read like the body's where) \u2014 a\n matching seed stays in the result with $stop == \"frontier\" and is not\n expanded; each destination's frontier is its own. There is no options block;\n the old `by` is $key. A bare follow ^docs (no brace, no consumer) is an\n error naming both block spellings.\n Type-preserving relations: block.children, section.children, section.subsections;\n the citation graph is out_links collect { from dst } / in_links collect { from doc }.\n from links where dst_path == \"/notes/x.md\" inbound links to a doc, as rows\n select d: dst.title, k: dst_kind from links the destination document's title\n from docs where out_links exists { where dst.layer == \"draft\" } links into drafts\n select b: in_links collect distinct { from doc } from docs backlinks as { id, path }\n select doc_id, dst_path from links where predicate == \"depends_on\"\n from docs where not doc.in_links exists { } orphans (nothing links in)\n (The `graph` tool is a convenience wrapper that compiles to a follow query.)\n\n## semantic grain\n\nfrom docs ranks whole DOCUMENTS (one hit per file); from blocks ranks PASSAGES.\ntext()/where prune the candidate set; only order by reweights.\n\n## Examples\n\n from docs where layer == \"working\"\n from docs where path.startsWith(\"/guides/\") and updated_at >= \"2026-08-01\"\n select layer, tags from docs where \"pricing\" in list(tags)\n from docs where inline.owner == \"alice\"\n from docs where title.lower().contains(\"q3 plan\")\n from docs where format == \"yaml\"\n from docs where type == \"practitioner\" order by era desc limit 2\n from docs where nodes none { where kind == \"md:task\" and not checked }\n from docs where tags exists { where $it == \"tria-prima\" }\n select fm: entries(data) collect { k: $key, v: $it } from docs where path == \"/x.md\"\n select owner_id, owner: ^nodes single { where kind == \"person\" and attrs.id == ^owner_id } from docs\n from blocks where type == \"task\" and not checked and under_heading(\"Launch\") and doc.layer == \"working\"\n from blocks where type == \"paragraph\" and has_edge(\"references\", \"d_92aaaaa\")\n select path, $depth from docs where path == \"/timeline/review.md\" follow refs(before), refs(after)\n select path, next: ^docs collect { path where ^path in list(before) } from docs where type == \"milestone\"\n select path, n: size(^docs), repo: ^id from docs limit 1\n select p: data.path, t: data.title from docs where has(data.path)\n docs { type == \"substance\" and not verified }\n select subject, process: ^docs[slug == ^subject]!.path from docs where type == \"lab-note\"\n select path, back: nodes first { select p: 0^docs collect { path where ^^path in list(after) } values } from docs where type == \"milestone\"\n select path, prior: refs(before) collect { path, when } from docs where type == \"milestone\"\n from blocks order by semantic(\"identity preservation across edits\") desc limit 10\n select uri from links where dst_kind == \"external\"\n docs count { where layer == \"canon\" }\n select seq, origin, ts, hash from revisions where path == \"/processes/calcination.md\" order by seq desc\n from docs where revisions count { where origin == \"api\" } > 0\n select p: path, d: doc.path from revisions where doc == null\n select layer, n: count(), titles: collect(title), open: rows count { where nodes exists { where kind == \"md:task\" and not checked } } from docs group by layer having count() > 1 order by count() desc\n\nCommon mistake: `$path`/`$id` (the 2.x spelling) \u2014 omgbase has no $ names; write\n`path`/`id`. Another: `where tags == \"x\"` on a list-valued key is false \u2014 write\n`\"x\" in tags`. Another: `select data.path` \u2014 alias it (`p: data.path`).\n";
|
|
1
|
+
export declare const QUERY_SYNTAX = "# query \u2014 OQX syntax reference\n\nThe `query` tool takes ONE plain OQX string (+ optional `limit`/`cursor`, and\n`bare: true` to drop the automatic `id`/`path` envelope \u2014 needs a `select`).\nThere is no {from, filter, order} envelope: every concern is a clause of the\nstring. Two rules tell the two syntaxes apart: DOT navigation belongs to the\nhost object model (`doc.layer`, `section.blocks`, `dst.title`); WHITESPACE\nquery directives belong to OQX \u2014 a nested query is `<receiver> collect|exists|\ncount|first|single { <block> }` (a postfix directive + a `{ \u2026 }` block), never a\nmethod. Its distinctive power is the receiver-constrained nested query that\ncorrelates to the current row: `from docs where nodes exists { where kind ==\n\"md:task\" }` returns only the docs that themselves contain a matching node.\n\n [select <items>] from <target> [where <pred>] [frontier <pred>] [follow <dest> [{ \u2026 }], \u2026]\n [flatten <expr> [{ \u2026 }] [as <name>]]\u2026 [group by <key>, \u2026] [having <pred>]\n [order by <expr> [asc|desc], \u2026] [limit N] [offset N]\n <target> count|exists|none|first|single { <block> } (scalar/one-row form: a bare target at the root scope)\n\nCLAUSE ORDER IS FIXED: select, from, where, frontier, follow, flatten, group by, having, order by, limit, offset \u2014\neach at most once (`flatten` may repeat); an out-of-order clause is a parse error naming the order.\nOnly `select` may drop its keyword, and only as the first clause\n(`path, era from docs where \u2026`). A top-level predicate needs `where`, because\n`where` follows `from` (`era > 1600 from docs` is the clause-order error); a\nblock may LEAD with a predicate (see Sugar), but a predicate after a projection\nstill needs the keyword (`{ name where kind == \"md:task\" }`, not\n`{ name, kind == \"md:task\" }`); `from docs count` is an error (write\n`docs count { \u2026 }`). `where` and later `select` items may use the same body's\n`select` aliases (`select path, old: era < 1000 from docs where old`; an alias\nshadows a same-named field there). `and` / `or` / `not` are the connectives;\nthe symbols `&&` / `||` / `!` are accepted synonyms (the words are canonical and\nwhat `print` writes).\n\n## Sugar (OQX 0.17)\n\nEvery form here is shorthand for an explicit directive (the AST is the explicit form):\n nodes { kind == \"md:task\" } \u2261 nodes collect { where kind == \"md:task\" } \u2014 a receiver block with\n no consumer is collect; a block whose LEADING expression is a predicate\n (comparison, call, !/is/not, in, literal, (\u2026), a consumer test \u2014 anything\n but a bare name, a dotted path or a ^lift) is where-first. Bare names still\n project: nodes { name } \u2261 nodes collect { name }; filter a bare field with\n nodes { is checked }. Wherever a value stands (0.20), call arguments included:\n size(children { is checked }); x distinct { \u2026 } \u2261 x collect distinct { \u2026 }. After a\n follow destination too: follow children { depth 2 } is that destination's block.\n (a, b) a tuple (0.20): two or more expressions, concatenated one level flat \u2014 a value\n (size((tags, aliases)), \"x\" in (tags, aliases)) and a receiver ((a, b) { \u2026 },\n follow (before, after) { depth 2 }); (a) alone is grouping\n refs(x)[0] \u2261 refs(x) first { offset 0 } positional (integer literal or ${binding});\n out of range \u21D2 absent; refs(x)[0].path navigates the row\n ^docs[path == ^company] \u2261 ^docs first { where path == ^company } first match or absent\n ^docs[path == ^company]! \u2261 \u2026 single { \u2026 } required: exactly one, else filter_invalid\n title! required: title, or an error naming the expression (and the row's $key \u2014 its id)\n \u2014 never a filter, never a coercion (0!, \"\"! are values); tightest: a!.b vs a.b!\n is x / not x truthiness of x, and its negation (prefix; `not` \u2261 `!`)\n x is y / x is not y identity ($key: a store row's id, else structural) \u2014 compares rows, which == does not;\n x is null = absent; for scalars is \u2261 ==; comparison precedence, no chaining\n a and b / a or b the connectives (\u2261 && / ||: same precedence, short-circuit, value: data.title or path coalesces)\n boss: ^docs[path == ^manager], bossName: boss.title a select item may use the items to its LEFT\n Reserved words (never a bare field name): from where select is not and or, true false null.\n Contextual words (limit order offset follow collect count first distinct desc by in frontier depth group having\n flatten as) parse as fields in expression position (select o: order from docs).\n\nResults are LEAN hits \u2014 { id, path } + whatever `select` projects (or `values`,\n`count`, `exists`, `none`). The envelope keys ARE the attributes: copy a hit's\n`id` straight into `where id == \"\u2026\"` (no translation); `select id, path` is simply\nthe envelope (no duplicate columns); any OTHER projection whose output key would\nbe `id` or `path` must be aliased \u2014 `select data.path` is refused (\"projection\n`path` collides with the hit envelope \u2014 alias it (`p: data.path`)\"); a row\nsurfacing as a value (an empty `collect { }`) is the same `{ id, path }`. Every\nother tool spells a row the same way (`docs_read` \u2192 `{ id, path, rev, properties,\nraw }`, `blocks_read` \u2192 `{ id, type, text, raw, hash, \u2026 }`, `docs_list` \u2192 `{ id,\npath, updated_at, blocks }`, a revision \u2192 `{ id, path, hash }`): hydrate by id via\nblocks_read/docs_read.\n\n## Paths\n\nEvery path the surface returns is `/`-rooted \u2014 the form a reference is\nwritten in (`[x](/projects/oqx.md)`, `before: [/timeline/kickoff.md]`): a\nhit's `path`, an edge's `dst_path`, every tool's paths. Every path it\naccepts tolerates both forms (`/a.md` or `a.md`): tool arguments, `refs(x)`,\n`within(...)`, and a string LITERAL compared with `path`/`dst_path` (bare, or\nthrough a row handle: `doc.path`) by `==`/`!=` or passed to their\n`.startsWith(...)` (it is rooted first, so `path == \"a.md\"` and `path == \"/a.md\"`\nboth match). A property holding a reference compares directly \u2014 and is never\nrooted: `where ^path in list(after)`, `where customer == ^path`,\n`where data.path == \"/x.md\"` (the author's `path:` key, as written) \u2014 no\n`\"/\" + ...` glue.\n\n## Targets & field namespaces\n\nTHE NAME RULE: `$` belongs to OQX \u2014 $it, $key, $depth, $stop, $leaf, $frontier,\n$ordinal are values the LANGUAGE injects into a scope; omgbase adds NO $ names\n(a `$id` in a query is an unknown name, absent). Every engine attribute is a BARE\nsnake_case name that WINS on collision \u2014 the convention the relations (children,\nblocks, out, in, doc, frontmatter, \u2026) always followed: a bare name that is an\nengine attribute reads the engine's value, never yours. Your data is bare too;\nwhere a key of yours collides with an engine name, reach it through a source\nhandle: `data.<k>` (the merged authored view \u2014 frontmatter + inline, exactly the\nread a bare non-colliding key performs), `frontmatter.<k>`, `inline.<k>`. So\n`path` is the engine's /-rooted location and `data.path` your `path:` key;\n`tags` is your tags \u222A the body #hashtags and `data.tags` the authored list alone;\n`title` the computed title (the first H1) and `data.title` your `title:`;\n`entries(data)` lists every authored top-level key. Same value, same name\neverywhere: a hit's `id` is docs_read's `id` and the `id` argument of blocks_read.\n\n Reserved bare names per kind (engine attributes; handles; self; relations):\n docs id path raw hash updated_at created_at title tags format | data frontmatter inline | doc | blocks nodes out_links in_links revisions\n blocks id path doc_id raw hash updated_at created_at type text attrs depth ordinal | block doc | children nodes out_links section\n nodes id path doc_id block_id kind name value attrs | section doc block | blocks subsections children\n links id path doc_id block_id via_id dst_id dst_path uri field dst_kind predicate provenance anchor | doc\n revisions id path rev seq doc_id commit ts origin actor reason hash is_current archived | doc\n A key of yours with any of these names is `data.<k>` (or frontmatter.<k> /\n inline.<k> by source; attrs.<k> on a block or node).\n UNKNOWN NAMES: a name that is none of the above AND that no object of the\n kind in this repository carries is reported before any row is read \u2014 on\n links as a filter_invalid error naming the fields; on docs/blocks/nodes the\n result gains `hints` (one line per name, nearest match when there is one)\n and the rows still come back; in a plan/apply/execute selector it is refused.\n A property some objects carry is known (partial presence is normal).\n\ndocs:\n - bare identifier = a document PROPERTY (frontmatter + inline `key:: value`,\n unioned; nested via dots: meta.owner). YAML/JSON docs\n expose the parsed object's keys the same way.\n - source handles = data.<k> (merged authored view) / frontmatter.<k> /\n inline.<k>; the whole bag as a collection via entries(data)\n / entries(frontmatter) / entries(inline) (see entries()).\n - attributes = id, path (/-rooted, see Paths), updated_at (ISO-8601,\n sorts chronologically), raw (the whole file, frontmatter\n included), hash (its sha256, 64 hex), title (the computed\n title: the first H1; data.title is the authored key), tags\n (authored tags \u222A body #hashtags, deduped, authored first;\n data.tags is the authored list), format (the doc's format \u2014\n \"markdown\"/\"yaml\"/\"json\"; present on EVERY doc, so\n has(format) is always true and `format == \"yaml\"` is the\n filter).\n - relations = nodes, blocks, doc.out_links / doc.in_links (a doc's\n links as rows; the documents at their other end are\n out_links collect distinct { from dst } and\n in_links collect distinct { from doc } \u2014 there is no\n out / in relation), revisions (the document's stored\n revisions, oldest first \u2014 see revisions below).\n\nblocks:\n - bare fields = doc_id (the owning doc), type, text (normalized), ordinal\n (0-based among siblings), depth (0 at the top level), and\n every attrs key FLATTENED onto the row (bare `checked`\n reads attrs.checked; `attrs.<k>` still works; the\n structural fields win on collision; absent \u21D2 false).\n - attributes = id, path (the owning doc's path), raw (the block's raw\n source \u2014 a container's raw holds its children), hash\n (its sha256 \u2014 the value update/split expect as\n expect.content_hash), updated_at.\n - reach-through = doc.<key> / doc.path / doc.id / doc.format = the\n CONTAINING doc (doc.id and doc.path cost nothing \u2014 they\n read the row's own doc_id / joined path, no lookup).\n - relations = block.children, block.nodes, block.out_links, section.\n NOTE: inside a `follow`, $depth/$ordinal are ALWAYS the walk's metadata; a\n block's own nesting is `depth` / `ordinal` (no $) everywhere.\n\nnodes:\n - bare fields = doc_id, block_id (null for a block-less node), kind\n (md:task / md:link / md:section / yaml:\u2026), name, value,\n + attrs keys flattened (checked, level).\n - attributes = id, path.\n - reach-through = doc.<key> / doc.id / doc.path, block.type / block.text\n / block.id / block.path.\n - relations = section.blocks, section.children, section.subsections.\n\nlinks: (the authored link graph as rows \u2014 one per open link: the relation a link\n establishes; the md:link NODE is its occurrence in the text and via_id\n points at it \u2014 a frontmatter link has a row and no node)\n - bare fields = doc_id (the SOURCE doc), block_id (the source block; null\n for a frontmatter edge), via_id, dst_id (the destination\n node id: a doc id, an external node id or phantom:<path>),\n dst_path (target doc path, /-rooted; NULL when\n dangling/external), uri (external URL; NULL otherwise),\n predicate (\"references\"/\"embeds\"/freeform), provenance\n (\"link\"/\"frontmatter\"/\"inline_field\"/\u2026), dst_kind\n (\"document\"/\"external\"/\"collection\"), anchor, field (the\n frontmatter key / inline field it was authored in).\n - attributes = id, path (the SOURCE doc's path); doc.<key> reaches the\n source document. There is no from_commit: a query sees\n open edges only (history is blocks_history/changes_since).\n - text()/semantic() are N/A on links.\n\nrevisions: (history as rows \u2014 one per stored revision of every document of the\n repository, deleted documents included: what docs_history lists, queryable)\n - bare fields = rev (= id), seq (1, 2, \u2026 per document), doc_id, commit,\n ts (the commit's time, sorts chronologically), origin\n (\"observed\"/\"api\"/\"import\"/\"projection\"), actor, reason,\n hash (the rendered file's sha256 \u2014 docs_history's hash),\n is_current (true for the document's current revision),\n archived (true when the bodies moved to an archive segment:\n the row stays, docs_read { at } reads through the segment).\n - attributes = id (the revision id, r_\u2026), path (the path the revision\n was committed under \u2014 a move re-paths only the current\n revision, so earlier ones keep the old path). doc.<key>\n reaches the document's CURRENT row; absent for a deleted\n document, so where doc == null is the revisions of deleted documents.\n - on docs = revisions is a relation (oldest first): a document with\n more than one version is docs { revisions count { } > 1 }.\n - text()/semantic() are N/A on revisions. The body as of a revision is\n docs_read { path, at: \"<rev>\" } (docs_read_at is the same call).\n\n## Scoping (ADR-015; the root row since surface 2.0): bare names are LOCAL\n\n name the CURRENT row only \u2014 never falls through to an enclosing row\n or the repository; an absent field is simply absent.\n ^name one scope OUT (the enclosing row's fields/intrinsics/lifts);\n ^^name two scopes out. `^path` = the enclosing row's path.\n ^docs ^nodes ^blocks ^links ^revisions\n THE ROOT ROW (surface 2.0, oqx 0.18): the repository is the root\n scope's row, one scope out from a top-level row, so ^docs there is\n the whole documents scan (uncorrelated until you add a ^ predicate);\n one caret per enclosing block (^^docs from depth two), or the\n absolute 0^docs from ANY depth. ^id / 0^id = the repository id.\n ^$it = the root object: ^$it.docs \u2261 ^docs, entries(^$it) names the\n five collections. At the root scope itself a bare target is the scan\n (docs count { \u2026 }, from docs, entries(docs)).\n ERRORS: a bare `docs` INSIDE a block reads a property of the current\n row, which has none \u2014 refused (\"did you mean ^docs\"); `^docs` AT THE\n TOP LEVEL reaches past the root \u2014 refused (write the bare `docs`);\n so is `$repo` (surface < 2.0; the message names the replacement).\n nodes/blocks on a doc row are that doc's RELATIONS, not the root.\n $it the current item itself (a row, or each ELEMENT when the\n receiver is a list property); ^$it = the enclosing row.\n $value is NOT an intrinsic (since oqx 0.15): it reads a\n property literally named $value, absent when there is none.\n $key the row's identity (0.20): a store row's id (doc/block/node/edge), an entries(x)\n entry's key, a follow occurrence's walk identity; project $key: <expr> to rekey the\n rows a block yields (a destination block's $key: is not a column).\n\n## Scalar semantics (@omgbase/oqx)\n\n comparisons == != < <= > >= strict & typed (5 == \"5\" is false); either\n side may be a field (field-vs-field OK).\n absence null and a missing field are the same \"absent\" value; two absents\n are EQUAL, so `absent != \"x\"` is TRUE and `absent == null` is TRUE.\n Relational (< <= > >=) on an absent operand \u2192 FALSE. Bare `f` in\n boolean position uses JS truthiness (absent/false/0/\"\" \u21D2 false;\n NOTE: \"false\", [] and {} are truthy). has(f) = explicit presence.\n boolean and or not grouping ( \u2026 ) \u2014 && || ! are accepted synonyms\n arithmetic + - * / % (+ concatenates if either side is a string)\n membership x in y array \u2192 typed membership; string \u2192 substring;\n object \u2192 key exists; range \u2192 coverage. Any list\n property works directly: \"pricing\" in tags. list(f)\n coerces scalar-or-list (absent \u2192 []) \u2014 use it when a\n key is sometimes scalar, sometimes a list.\n ranges lo..hi (inclusive) lo...hi (exclusive hi) ..hi lo..\n era in 800..1680; works over ISO dates. range(prop) reads a\n range-shaped STRING property as an interval: \"2026-01-15\" in range(window).\n strings x.contains(\"s\") x.startsWith(\"p\") x.endsWith(\"s\") x.matches(\"^re$\")\n (real regex) x.lower() x.upper() size(x). ALL CASE-SENSITIVE \u2014\n fold with .lower(): title.lower().contains(\"aurora\").\n Infix regex: x ~ \"re\" is x.matches(\"re\"); x ~* \"re\" is the\n case-insensitive match; x !~ \"re\" and x !~* \"re\" negate them.\n Unanchored unless the pattern anchors; an absent x is false\n under ~ and TRUE under !~ (not SQL's NULL).\n functions has(f) size(x) list(x) entries(x) range(s)\n dates a date is an ISO string, a duration a NUMBER OF SECONDS; arithmetic\n is METHODS, never + or - (+ concatenates strings).\n date(\"today\"|\"now\"|\"yesterday\"|\"tomorrow\"|\"sow\"|\"eow\"|\"som\"|\"eom\"|\n \"soy\"|\"eoy\") \u2014 the host clock, UTC; date(\"2026-10-15\") canonical ISO\n (absent if unparseable). dur(\"1h30m\") dur(\"2 days, 3 hours\")\n dur(\"P1DT2H\") dur(90) \u2192 seconds (year = 365 d, month = 30 d).\n d.plus(dur(\"30 days\")) d.minus(86400) d.plus(\"1 month\") (calendar:\n Jan 31 \u2192 Feb 28) a.until(b) \u2192 signed seconds d.year() d.month()\n d.day() d.weekday() (1 = Mon) d.hour() d.minute() d.second()\n d.date() d.format(\"EEE dd MMM yyyy\") n.dur_text() \u2192 \"1h 30m\"\n n.dur_iso() \u2192 \"PT1H30M\". Total: a non-date is absent, so\n `where date(due) < date(\"today\").minus(dur(\"30 days\"))` just\n filters. A datetime is never < its own date: compare\n updated_at.date() == date(\"today\"), or < date(\"tomorrow\").\n literals \"str\" 'str' 123 1.5 true false null\n determinism no random; the only clock is date(\"today\"/\"now\"/\u2026), read once per\n query. Lists/structs are not literals; ternary is not supported.\n Errors surface as filter_invalid.\n scalars vs lists a list-authored key never == a scalar (tags == \"x\" is false\n when tags is a list) \u2014 use `\"x\" in tags` / `in list(tags)`.\n\n## Domain predicates (omgbase)\n\n text(\"terms\") FTS5 PRUNING predicate (docs match via their blocks, nodes\n via the node index); composes anywhere, incl. nested scopes.\n semantic(\"phrase\") embedding cosine SCORE (docs/blocks): threshold it\n (semantic(\"x\") > 0.6), project it, or `order by semantic(\"x\")\n desc` for top-K. Needs a provider that has embedded the repository; else provider_unavailable.\n blocks target only:\n under(id_or_heading) block in the containment subtree / section range\n under_heading(\"Launch\") an ancestor section heading contains the text (ci)\n under_kind(type[, name]) an ancestor block has that type (name: its text\n contains / its key equals name)\n within(\"path\" | \"d_..\") containing doc = id, exact path, or path glob (*);\n either path form\n yaml_path(\"a.b\") YAML docs: the block at that key path\n json_pointer(\"#/a/b\") JSON docs: the block at that pointer\n has_edge(\"pred\"[, target]) an open authored edge with that predicate leaves here\n has_anchor() block carries an authored ^ref\n parent_type() == \"x\" parent block's type (must be compared)\n child_count() > 0 number of direct children (must be compared)\n refs(x) the live documents a property's document references name:\n x is a string, a list or absent; each \"/a/b.md\", \"a/b.md\"\n or \"d_\u2026\" element resolves to that doc's row; dangling and\n non-string elements are dropped. Yields docs rows, so it is\n a source, a receiver or a follow destination:\n follow refs(before), refs(after) walks a timeline both ways.\n The reverse direction needs no function: a document's\n path is already the reference form, so\n ^docs { where ^path in list(after) } is\n \"the documents whose `after` names me\".\n A HIT IS A STORE ROW: a top-level row that is not a doc/block/node/edge fails\n (filter_invalid). `follow before` over a list of paths\n reaches the STRINGS \u2014 write `follow refs(before)`.\n\n## Nested queries & consumers\n\n <receiver> collect|exists|none|count|first|single { <block> }\n receiver = a relation (nodes, blocks, doc.out_links, section.blocks, \u2026), a\n reach-through row (dst, doc: one row \u2014 dst { title }), a\n list property (tags), entries(x), or a root collection (^docs; 0^docs at depth \u2265 2).\n block = [select \u2026] [from E] [where \u2026] [frontier \u2026] [follow \u2026] [flatten \u2026] [group by \u2026] [having \u2026] [order by \u2026] [limit N] [offset N]\n \u2014 the same fixed order as the top level (`from` optional; the\n receiver supplies the rows). A leading name/alias list is the\n projection (`select` dropped); a predicate always needs `where`.\n A `from E` inside a block RE-PROJECTS the rows through a relation\n (a typed flatMap): `docs collect { from nodes where kind == \"md:task\" }`\n starts at docs, projects each through `nodes`, and queries the\n resulting nodes; a scalar relation (`from doc`) contributes one\n row; a missing or non-navigable relation is a loud error, never a\n global scan.\n exists \u22651 row nodes exists { where kind == \"md:task\" and not checked }\n none 0 rows nodes none { where kind == \"md:task\" and not checked } (\"every task done\")\n count a number nodes count { where kind == \"md:task\" } >= 2\n collect rows (default) \u2014 in select for nested results; in where with a lift\n first / single zero-or-one (single errors on >1) \u2014 lookups in select\n distinct on any consumer: dedup by projected value \u2014 nodes count distinct { select kind }\n limit/offset bound the block's rows AFTER where/order/distinct, BEFORE the\n consumer reduces: nodes exists { offset 1 } = at least two;\n first { \u2026 offset 1 } = the second.\n lift `^name:` in a where-collect binds values outward:\n select path, open from docs where nodes collect { ^open: value where kind == \"md:task\" and not checked }\n joins ^<t> exists { where slug == ^ref } semi-join; not \u2026 exists anti-join;\n ^nodes single { where kind == \"person\" and attrs.id == ^owner_id } lookup;\n x in ^keys membership over a lifted set.\n\n## select \u2014 projection\n\n select a, alias: expr, nested: nodes collect { \u2026 }\n bare key \u2192 the attribute when it is one (id, path, title, \u2026), else the property\n (scalar-authored \u2192 scalar; list \u2192 array); data.<k> forces the property;\n a call/arithmetic needs an alias (n: size(tags)) unless in values mode;\n an output key of id/path other than the attribute itself needs an alias.\n raw whole file bytes (docs) \u2014 docs_read is cheaper for one doc.\n distinct select distinct type (dedup hits by projected value)\n values select <ONE item> values \u2192 bare values instead of records:\n select distinct type values from docs \u2192 values: [\"hub\",\"lab-note\",\u2026]\n select path values from docs \u2192 values: [\"/index.md\", \u2026]\n tags: tags collect { $it values } \u2192 a plain array\n h: nodes first { name values where kind == \"md:section\" order by first_ordinal }\n entries(x) a record as a collection ($key / $it per entry), key order:\n select fm: entries(data) collect { k: $key, v: $it }\n where entries(frontmatter) exists { where $key == \"era\" and $it > 1600 }\n entries(inline), entries(attrs), a nested map, or a list (index keys)\n $semantic_score is not a field \u2014 project semantic(\"\u2026\") under an alias instead.\n\n## flatten (OQX 0.25)\n\n flatten <expr> [{ \u2026 }] [as <name>] after follow, before group by; may repeat\n Splits one value into rows. Every hit is still the PARENT row \u2014 its id/path\n repeat per element, as Dataview's TABLE \u2026 FLATTEN \u2014 with <name> bound beside\n its fields at the same depth: an array \u2192 one row per element (an empty list\n yields none), a missing field \u2192 one row with the name absent (never dropped),\n an object or a scalar \u2192 one row with the value. A plain navigation names\n itself (flatten tags rebinds tags to each element); anything else needs as.\n The block is the ordinary receiver block over the elements (where, a\n projection, order by, limit, distinct), applied first. Later clauses read the\n name \u2014 a later flatten (flatten jobs as j flatten j.tags as t), group by,\n having, select, order by; where runs before it. A flattened query pages by\n position (cursor null); as id / as path is refused (the envelope reads them).\n select path, tags from docs where type == \"process\" flatten tags order by path, tags\n select path, t: b.text from docs flatten blocks { where type == \"task\" and not checked } as b\n select tags, n: count() from docs flatten tags group by tags order by count() desc\n\n## order by, limit/offset, pagination\n\n order by era desc, path asc absent values sort LAST (asc); ties \u2192 (path, id)\n limit N / offset N define the result SET (integer literals);\n the tool's limit/cursor then page WITHIN it\n cursor opaque keyset on (path,id); a custom order by\n disables it (you get the top page + truncated)\n\n## Graph traversal (follow) and links\n\n The citation graph is the LINK ROWS walked through a destination block:\n dst is a link's destination document (absent for an external or dangling\n link \u2014 it then contributes no successor), doc its source.\n from docs where <seed> follow out_links collect { from dst } docs the seed links TO\n from docs where <seed> follow in_links collect { from doc } backlinks\n follow out_links collect { from dst depth 3 } bound (1..8, default 8) \u2014 a clause of the block\n follow out_links collect { from dst where layer == \"canon\" } keep only matching successors\n follow in_links collect { from doc where ^path in list(before) } ^ = the row being expanded\n (^^ = the walk's enclosing scope)\n follow out_links collect { from dst where predicate == \"depends_on\" } one predicate only\n follow out_links collect { from dst }, in_links collect { from doc }\n several destinations: their union\n (one step dedups by identity)\n follow ^docs { where out_links exists { where dst_path == ^^path } }\n a destination block over the root's\n documents, re-read per frontier row\n (^ = that row) = the backlinks walk\n follow out_links collect { from dst frontier type == \"practitioner\" } cut, keeping the frontier row\n from docs where type == \"process\" frontier !verified follow out_links collect { from dst }\n the BODY's frontier applies to the seeds:\n an unverified seed is kept, not expanded\n follow distinct out_links collect { from dst } / \u2026 { $key: group from dst } identity control ($key)\n follow refs(before), ^docs { where ^path in list(after) } forward over `before`, backward\n over every doc whose `after` names me\n Per-occurrence metadata: $depth (seed = 1), $stop (interior|leaf|frontier|\n depth|cycle), $leaf/$frontier, $ordinal (a deterministic 1..N rank over the\n walk, ordered by depth then path \u2014 `order by $ordinal` for walk order,\n `where $ordinal <= N` for a deterministic budget cut), $key \u2014 usable in\n select/order by and the top-level post-walk where (a where conjunct that\n reads one filters the walk's RESULT; the other conjuncts remain the seed\n predicate), NOT metadata of the candidates a destination block's where reads,\n nor valid inside a consumer directive. Cyclic graphs are safe: a revisited\n node is admitted once as a `$stop == \"cycle\"` occurrence and never\n re-expanded. The default keeps one occurrence per distinct walk path;\n `follow distinct` dedups reached rows by identity.\n Destination blocks (OQX 0.20): a brace after ANY destination opens that\n destination's block \u2014 children { depth 2 }, refs(x) { depth 2 }, out_links\n collect { from dst depth 2 }, ^docs { where ^path in list(after) } \u2014 with the\n 0.17 body rules (where-first, projections) and two clauses of its own after\n `where`: frontier <pred> (occurrences reached through this destination that\n match are frontiers; ^ there is the walk's enclosing scope) and depth <n>\n (this destination expands a frontier row only while $depth < n). The body\n that carries the follow may write frontier <pred> too, after its where and\n before follow: it applies to the SEEDS (read like the body's where) \u2014 a\n matching seed stays in the result with $stop == \"frontier\" and is not\n expanded; each destination's frontier is its own. There is no options block;\n the old `by` is $key. A bare follow ^docs (no brace, no consumer) is an\n error naming both block spellings.\n Type-preserving relations: block.children, section.children, section.subsections;\n the citation graph is out_links collect { from dst } / in_links collect { from doc }.\n from links where dst_path == \"/notes/x.md\" inbound links to a doc, as rows\n select d: dst.title, k: dst_kind from links the destination document's title\n from docs where out_links exists { where dst.layer == \"draft\" } links into drafts\n select b: in_links collect distinct { from doc } from docs backlinks as { id, path }\n select doc_id, dst_path from links where predicate == \"depends_on\"\n from docs where not doc.in_links exists { } orphans (nothing links in)\n (The `graph` tool is a convenience wrapper that compiles to a follow query.)\n\n## semantic grain\n\nfrom docs ranks whole DOCUMENTS (one hit per file); from blocks ranks PASSAGES.\ntext()/where prune the candidate set; only order by reweights.\n\n## Examples\n\n from docs where layer == \"working\"\n from docs where path.startsWith(\"/guides/\") and updated_at >= \"2026-08-01\"\n select layer, tags from docs where \"pricing\" in list(tags)\n from docs where inline.owner == \"alice\"\n from docs where title.lower().contains(\"q3 plan\")\n from docs where format == \"yaml\"\n from docs where type == \"practitioner\" order by era desc limit 2\n from docs where nodes none { where kind == \"md:task\" and not checked }\n from docs where tags exists { where $it == \"tria-prima\" }\n select fm: entries(data) collect { k: $key, v: $it } from docs where path == \"/x.md\"\n select owner_id, owner: ^nodes single { where kind == \"person\" and attrs.id == ^owner_id } from docs\n from blocks where type == \"task\" and not checked and under_heading(\"Launch\") and doc.layer == \"working\"\n from blocks where type == \"paragraph\" and has_edge(\"references\", \"d_92aaaaa\")\n select path, $depth from docs where path == \"/timeline/review.md\" follow refs(before), refs(after)\n select path, next: ^docs collect { path where ^path in list(before) } from docs where type == \"milestone\"\n select path, n: size(^docs), repo: ^id from docs limit 1\n select p: data.path, t: data.title from docs where has(data.path)\n docs { type == \"substance\" and not verified }\n select subject, process: ^docs[slug == ^subject]!.path from docs where type == \"lab-note\"\n select path, back: nodes first { select p: 0^docs collect { path where ^^path in list(after) } values } from docs where type == \"milestone\"\n select path, prior: refs(before) collect { path, when } from docs where type == \"milestone\"\n from blocks order by semantic(\"identity preservation across edits\") desc limit 10\n select uri from links where dst_kind == \"external\"\n docs count { where layer == \"canon\" }\n select seq, origin, ts, hash from revisions where path == \"/processes/calcination.md\" order by seq desc\n from docs where revisions count { where origin == \"api\" } > 0\n select p: path, d: doc.path from revisions where doc == null\n select layer, n: count(), titles: collect(title), open: rows count { where nodes exists { where kind == \"md:task\" and not checked } } from docs group by layer having count() > 1 order by count() desc\n select path, tag: tags from docs where \"process\" in tags flatten tags order by path, tags\n\nCommon mistake: `$path`/`$id` (the 2.x spelling) \u2014 omgbase has no $ names; write\n`path`/`id`. Another: `where tags == \"x\"` on a list-valued key is false \u2014 write\n`\"x\" in tags`. Another: `select data.path` \u2014 alias it (`p: data.path`).\n";
|
|
@@ -19,11 +19,12 @@ correlates to the current row: \`from docs where nodes exists { where kind ==
|
|
|
19
19
|
"md:task" }\` returns only the docs that themselves contain a matching node.
|
|
20
20
|
|
|
21
21
|
[select <items>] from <target> [where <pred>] [frontier <pred>] [follow <dest> [{ … }], …]
|
|
22
|
-
[
|
|
22
|
+
[flatten <expr> [{ … }] [as <name>]]… [group by <key>, …] [having <pred>]
|
|
23
|
+
[order by <expr> [asc|desc], …] [limit N] [offset N]
|
|
23
24
|
<target> count|exists|none|first|single { <block> } (scalar/one-row form: a bare target at the root scope)
|
|
24
25
|
|
|
25
|
-
CLAUSE ORDER IS FIXED: select, from, where, frontier, follow, group by, having, order by, limit, offset —
|
|
26
|
-
each at most once; an out-of-order clause is a parse error naming the order.
|
|
26
|
+
CLAUSE ORDER IS FIXED: select, from, where, frontier, follow, flatten, group by, having, order by, limit, offset —
|
|
27
|
+
each at most once (\`flatten\` may repeat); an out-of-order clause is a parse error naming the order.
|
|
27
28
|
Only \`select\` may drop its keyword, and only as the first clause
|
|
28
29
|
(\`path, era from docs where …\`). A top-level predicate needs \`where\`, because
|
|
29
30
|
\`where\` follows \`from\` (\`era > 1600 from docs\` is the clause-order error); a
|
|
@@ -62,8 +63,8 @@ Every form here is shorthand for an explicit directive (the AST is the explicit
|
|
|
62
63
|
a and b / a or b the connectives (≡ && / ||: same precedence, short-circuit, value: data.title or path coalesces)
|
|
63
64
|
boss: ^docs[path == ^manager], bossName: boss.title a select item may use the items to its LEFT
|
|
64
65
|
Reserved words (never a bare field name): from where select is not and or, true false null.
|
|
65
|
-
Contextual words (limit order offset follow collect count first distinct desc by in frontier depth
|
|
66
|
-
fields in expression position (select o: order from docs).
|
|
66
|
+
Contextual words (limit order offset follow collect count first distinct desc by in frontier depth group having
|
|
67
|
+
flatten as) parse as fields in expression position (select o: order from docs).
|
|
67
68
|
|
|
68
69
|
Results are LEAN hits — { id, path } + whatever \`select\` projects (or \`values\`,
|
|
69
70
|
\`count\`, \`exists\`, \`none\`). The envelope keys ARE the attributes: copy a hit's
|
|
@@ -109,8 +110,8 @@ read a bare non-colliding key performs), \`frontmatter.<k>\`, \`inline.<k>\`. So
|
|
|
109
110
|
everywhere: a hit's \`id\` is docs_read's \`id\` and the \`id\` argument of blocks_read.
|
|
110
111
|
|
|
111
112
|
Reserved bare names per kind (engine attributes; handles; self; relations):
|
|
112
|
-
docs id path raw hash updated_at title tags format | data frontmatter inline | doc | blocks nodes out_links in_links revisions
|
|
113
|
-
blocks id path doc_id raw hash updated_at type text attrs depth ordinal | block doc | children nodes out_links section
|
|
113
|
+
docs id path raw hash updated_at created_at title tags format | data frontmatter inline | doc | blocks nodes out_links in_links revisions
|
|
114
|
+
blocks id path doc_id raw hash updated_at created_at type text attrs depth ordinal | block doc | children nodes out_links section
|
|
114
115
|
nodes id path doc_id block_id kind name value attrs | section doc block | blocks subsections children
|
|
115
116
|
links id path doc_id block_id via_id dst_id dst_path uri field dst_kind predicate provenance anchor | doc
|
|
116
117
|
revisions id path rev seq doc_id commit ts origin actor reason hash is_current archived | doc
|
|
@@ -324,7 +325,7 @@ revisions: (history as rows — one per stored revision of every document of th
|
|
|
324
325
|
receiver = a relation (nodes, blocks, doc.out_links, section.blocks, …), a
|
|
325
326
|
reach-through row (dst, doc: one row — dst { title }), a
|
|
326
327
|
list property (tags), entries(x), or a root collection (^docs; 0^docs at depth ≥ 2).
|
|
327
|
-
block = [select …] [from E] [where …] [frontier …] [follow …] [order by …] [limit N] [offset N]
|
|
328
|
+
block = [select …] [from E] [where …] [frontier …] [follow …] [flatten …] [group by …] [having …] [order by …] [limit N] [offset N]
|
|
328
329
|
— the same fixed order as the top level (\`from\` optional; the
|
|
329
330
|
receiver supplies the rows). A leading name/alias list is the
|
|
330
331
|
projection (\`select\` dropped); a predicate always needs \`where\`.
|
|
@@ -369,6 +370,24 @@ revisions: (history as rows — one per stored revision of every document of th
|
|
|
369
370
|
entries(inline), entries(attrs), a nested map, or a list (index keys)
|
|
370
371
|
$semantic_score is not a field — project semantic("…") under an alias instead.
|
|
371
372
|
|
|
373
|
+
## flatten (OQX 0.25)
|
|
374
|
+
|
|
375
|
+
flatten <expr> [{ … }] [as <name>] after follow, before group by; may repeat
|
|
376
|
+
Splits one value into rows. Every hit is still the PARENT row — its id/path
|
|
377
|
+
repeat per element, as Dataview's TABLE … FLATTEN — with <name> bound beside
|
|
378
|
+
its fields at the same depth: an array → one row per element (an empty list
|
|
379
|
+
yields none), a missing field → one row with the name absent (never dropped),
|
|
380
|
+
an object or a scalar → one row with the value. A plain navigation names
|
|
381
|
+
itself (flatten tags rebinds tags to each element); anything else needs as.
|
|
382
|
+
The block is the ordinary receiver block over the elements (where, a
|
|
383
|
+
projection, order by, limit, distinct), applied first. Later clauses read the
|
|
384
|
+
name — a later flatten (flatten jobs as j flatten j.tags as t), group by,
|
|
385
|
+
having, select, order by; where runs before it. A flattened query pages by
|
|
386
|
+
position (cursor null); as id / as path is refused (the envelope reads them).
|
|
387
|
+
select path, tags from docs where type == "process" flatten tags order by path, tags
|
|
388
|
+
select path, t: b.text from docs flatten blocks { where type == "task" and not checked } as b
|
|
389
|
+
select tags, n: count() from docs flatten tags group by tags order by count() desc
|
|
390
|
+
|
|
372
391
|
## order by, limit/offset, pagination
|
|
373
392
|
|
|
374
393
|
order by era desc, path asc absent values sort LAST (asc); ties → (path, id)
|
|
@@ -472,6 +491,7 @@ text()/where prune the candidate set; only order by reweights.
|
|
|
472
491
|
from docs where revisions count { where origin == "api" } > 0
|
|
473
492
|
select p: path, d: doc.path from revisions where doc == null
|
|
474
493
|
select layer, n: count(), titles: collect(title), open: rows count { where nodes exists { where kind == "md:task" and not checked } } from docs group by layer having count() > 1 order by count() desc
|
|
494
|
+
select path, tag: tags from docs where "process" in tags flatten tags order by path, tags
|
|
475
495
|
|
|
476
496
|
Common mistake: \`$path\`/\`$id\` (the 2.x spelling) — omgbase has no $ names; write
|
|
477
497
|
\`path\`/\`id\`. Another: \`where tags == "x"\` on a list-valued key is false — write
|
|
@@ -616,7 +616,11 @@ export function compileSelection(store, repoId, select, expectRaw, templatesRaw)
|
|
|
616
616
|
fix: fixRequest({ select, effects: templatesRaw, expect: { max: count } }),
|
|
617
617
|
});
|
|
618
618
|
}
|
|
619
|
-
// Row → effects: hits in result order × templates in order (k = h·T + t).
|
|
619
|
+
// Row → effects: hits in result order × templates in order (k = h·T + t). A
|
|
620
|
+
// selector with `flatten` (oqx 0.25; §11.8) fans out per FLATTENED row: each
|
|
621
|
+
// hit is the parent row (its `id`/`path`), the slot items read the bound name
|
|
622
|
+
// (`-> tag`) in the flattened scope, and `expect.max` — the page bound above —
|
|
623
|
+
// counts the flattened hits.
|
|
620
624
|
const effects = [];
|
|
621
625
|
const origins = [];
|
|
622
626
|
hits.forEach((hit) => {
|
|
@@ -45,7 +45,9 @@ function tagAll(rows, t) {
|
|
|
45
45
|
// (`children`, `blocks`, `out_links`, `doc`, `frontmatter`, …) always followed:
|
|
46
46
|
// a bare name that is an engine attribute reads the engine's value, never the
|
|
47
47
|
// author's. The attributes: every row's `id`/`path`; docs' and blocks' `raw`/
|
|
48
|
-
// `hash`/`updated_at
|
|
48
|
+
// `hash`/`updated_at`/`created_at` (4.10: the commit `ts` of the thing's first
|
|
49
|
+
// revision / earliest `block_changes` row — "first observed by omgbase", not a
|
|
50
|
+
// filesystem time); docs' `title` (the computed title) and `tags` (authored
|
|
49
51
|
// tags ∪ body hashtags) and `format`; a foreign key named for what it is
|
|
50
52
|
// (`doc_id`, `block_id`, `via_id`, `dst_id`, `dst_path`, `uri`), a column its
|
|
51
53
|
// column (`type`, `text`, `depth`, `ordinal`, `kind`, `predicate`, `field`).
|
|
@@ -60,8 +62,8 @@ function tagAll(rows, t) {
|
|
|
60
62
|
// target name — `docs`, `links`, … — is a loud error of its own (root-row.ts).
|
|
61
63
|
// `revisions` on a document is a RELATION (its revision list, §1.2, 4.7) in
|
|
62
64
|
// `rel.docs` below, and names.ts's `RELATIONS.docs` knows it as one.
|
|
63
|
-
const DOC_ATTRIBUTES = new Set(["id", "path", "raw", "hash", "updated_at", "title", "tags", "format"]);
|
|
64
|
-
const BLOCK_ATTRIBUTES = new Set(["id", "path", "raw", "hash", "updated_at", "doc_id", "type", "text", "attrs", "depth", "ordinal"]);
|
|
65
|
+
const DOC_ATTRIBUTES = new Set(["id", "path", "raw", "hash", "updated_at", "created_at", "title", "tags", "format"]);
|
|
66
|
+
const BLOCK_ATTRIBUTES = new Set(["id", "path", "raw", "hash", "updated_at", "created_at", "doc_id", "type", "text", "attrs", "depth", "ordinal"]);
|
|
65
67
|
const NODE_ATTRIBUTES = new Set(["id", "path", "doc_id", "block_id", "kind", "name", "value", "attrs"]);
|
|
66
68
|
const EDGE_ATTRIBUTES = new Set(["id", "path", "doc_id", "block_id", "via_id", "dst_id", "dst_path", "uri", "field", "dst_kind", "predicate", "provenance", "anchor"]);
|
|
67
69
|
// The history target (spec/surface §1.2, 4.7): a revision row's own columns
|
|
@@ -464,6 +466,12 @@ export function makeStoreContext(store, repoId, opts = {}) {
|
|
|
464
466
|
case "path": return referencePath(String(row.path));
|
|
465
467
|
case "hash": return row.file_hash == null ? null : hex(row.file_hash);
|
|
466
468
|
case "updated_at": return scalar(`SELECT c.ts FROM revisions r JOIN commits c ON c.commit_id = r.commit_id WHERE r.rev_id = ?`, row.current_rev) ?? null;
|
|
469
|
+
// `created_at` (4.10): the commit `ts` of the document's first revision
|
|
470
|
+
// (`seq = 1`, the row `revisions first { ts values }` reads) — when
|
|
471
|
+
// omgbase first observed the document, not a filesystem time. The
|
|
472
|
+
// retention squash (spec/store §7.1, 15.0) keeps every revision and
|
|
473
|
+
// commit row, so the value survives archiving.
|
|
474
|
+
case "created_at": return scalar(`SELECT c.ts FROM revisions r JOIN commits c ON c.commit_id = r.commit_id WHERE r.doc_id = ? AND r.seq = 1`, row.doc_id) ?? null;
|
|
467
475
|
// `raw`: the exact file bytes (spec/store §6.1, frontmatter included).
|
|
468
476
|
case "raw": return docsRead(store, String(row.doc_id))?.raw ?? null;
|
|
469
477
|
// `title`: the computed title (spec/properties §3.3 — the authored
|
|
@@ -487,6 +495,13 @@ export function makeStoreContext(store, repoId, opts = {}) {
|
|
|
487
495
|
case "raw": return row.raw_hash == null ? null : scalar(`SELECT bytes FROM blobs WHERE hash = ?`, row.raw_hash)?.toString("utf8") ?? null;
|
|
488
496
|
case "hash": return row.raw_hash == null ? null : hex(row.raw_hash);
|
|
489
497
|
case "updated_at": return scalar(`SELECT MAX(c.ts) FROM block_changes bc JOIN commits c ON c.commit_id = bc.commit_id WHERE bc.block_id = ?`, row.block_id) ?? null;
|
|
498
|
+
// `created_at` (4.10): the EARLIEST commit `ts` among the block's
|
|
499
|
+
// `block_changes` — the same join as `updated_at` under MIN: the commit
|
|
500
|
+
// that first wrote the id (`inserted`, or the split/merge lineage row
|
|
501
|
+
// that minted it). Store 14.2 keeps that row and the 15.0 squash keeps
|
|
502
|
+
// each block's earliest row (spec/store §7.1), so it survives archiving;
|
|
503
|
+
// a resurrected block keeps its original creation.
|
|
504
|
+
case "created_at": return scalar(`SELECT MIN(c.ts) FROM block_changes bc JOIN commits c ON c.commit_id = bc.commit_id WHERE bc.block_id = ?`, row.block_id) ?? null;
|
|
490
505
|
case "doc_id": return row.doc_id;
|
|
491
506
|
case "type": return row.type;
|
|
492
507
|
case "text": return row.text;
|
|
@@ -97,6 +97,9 @@ function subMayRaise(s, target) {
|
|
|
97
97
|
return true;
|
|
98
98
|
if (s.having && whereMayRaise(s.having, target, false))
|
|
99
99
|
return true;
|
|
100
|
+
// A flattened block (oqx 0.25) evaluates each `flatten` expression per row.
|
|
101
|
+
if (s.flatten.some((f) => exprMayRaise(f.expr, target, false)))
|
|
102
|
+
return true;
|
|
100
103
|
if (s.limit && exprMayRaise(s.limit, target, false))
|
|
101
104
|
return true;
|
|
102
105
|
if (s.offset && exprMayRaise(s.offset, target, false))
|
|
@@ -158,13 +161,14 @@ export class SQLiteQueryPlanner {
|
|
|
158
161
|
}
|
|
159
162
|
plan(query, params) {
|
|
160
163
|
// Only simple top-level scans: no follow, no `from E` re-projection, no
|
|
161
|
-
// `group by` (oqx 0.24)
|
|
162
|
-
// conjuncts could be pushed (
|
|
163
|
-
//
|
|
164
|
-
//
|
|
165
|
-
//
|
|
166
|
-
//
|
|
167
|
-
|
|
164
|
+
// `group by` (oqx 0.24), no `flatten` (oqx 0.25). A grouped or flattened
|
|
165
|
+
// query is declined whole: its `where` conjuncts could be pushed (the fan-out
|
|
166
|
+
// and the grouping happen after them, so the residual would flatten and
|
|
167
|
+
// group the produced rows correctly), but a pushed conjunct that empties the
|
|
168
|
+
// scan would hide an eval error a `flatten` expression, an aggregate or
|
|
169
|
+
// `having` raises in memory (`x!`, `sum` over a string) — decline (c)
|
|
170
|
+
// extended to the post-where clauses. SQL pushdown of either is a later round.
|
|
171
|
+
if (query.follow || query.from.length > 0 || query.groupBy || query.flatten.length > 0)
|
|
168
172
|
return null;
|
|
169
173
|
const target = rootTarget(query.source);
|
|
170
174
|
if (!target)
|
package/dist/src/oqx-js/run.js
CHANGED
|
@@ -384,6 +384,21 @@ function runResolved(store, repoId, raw, opts) {
|
|
|
384
384
|
// under a custom `order by`). `distinct` cannot occur (a parse error).
|
|
385
385
|
if (parsed.groupBy)
|
|
386
386
|
return runGrouped(engine, parsed, consumer, opts);
|
|
387
|
+
// A flattened query (oqx 0.25, SEMANTICS §25) yields the parent rows, one per
|
|
388
|
+
// element: a hit is still a store row, so the envelope is injected as usual
|
|
389
|
+
// and repeats per element (Dataview's `TABLE … FLATTEN`). What changes is
|
|
390
|
+
// uniqueness — `(path, id)` no longer names one hit — so the keyset cursor
|
|
391
|
+
// cannot land inside a document's elements: a flattened query pages
|
|
392
|
+
// positionally with a null cursor, as a grouped query and a custom `order by`
|
|
393
|
+
// do (a keyset extended with the flatten ordinal is a later round). A bound
|
|
394
|
+
// name of `id` or `path` would shadow the envelope's own reads (the name
|
|
395
|
+
// shadows a same-named row property on the flattened row): refused, like a
|
|
396
|
+
// projection that collides with the envelope.
|
|
397
|
+
const flattened = parsed.flatten.length > 0;
|
|
398
|
+
for (const f of parsed.flatten) {
|
|
399
|
+
if (ENVELOPE_KEYS.has(f.name))
|
|
400
|
+
throw new FilterInvalid(`flatten \`as ${f.name}\` collides with the hit envelope — a flattened row is still the row, whose \`${f.name}\` the envelope reads; bind another name`, "OQX");
|
|
401
|
+
}
|
|
387
402
|
// collect / first / single: inject id + path so every hit carries them. A
|
|
388
403
|
// top-level `select distinct` is applied HERE, not in the engine: the injected
|
|
389
404
|
// id/path are unique per row and would defeat the engine's projection dedup, so
|
|
@@ -437,7 +452,7 @@ function runResolved(store, repoId, raw, opts) {
|
|
|
437
452
|
const limit = constBound(topLimit, "limit");
|
|
438
453
|
if (offset || limit != null)
|
|
439
454
|
rows = rows.slice(offset, limit == null ? undefined : offset + limit);
|
|
440
|
-
const custom = !!parsed.orderBy && parsed.orderBy.length > 0;
|
|
455
|
+
const custom = (!!parsed.orderBy && parsed.orderBy.length > 0) || flattened;
|
|
441
456
|
const cap = opts.limit ?? 50;
|
|
442
457
|
let page = rows;
|
|
443
458
|
if (!custom && opts.cursor) {
|
|
@@ -60,14 +60,16 @@ export const NON_PROPERTY_NAMES = {
|
|
|
60
60
|
};
|
|
61
61
|
// ---- engine attributes ------------------------------------------------------
|
|
62
62
|
// The engine attributes (spec/surface §1.2, 3.0: bare, snake_case, winning on
|
|
63
|
-
// collision — `id`, `path`, `raw`, `hash`, `updated_at` on docs
|
|
64
|
-
// `title`/`tags` on docs, `id`/`path` on nodes and edges) → a param-free SQL
|
|
63
|
+
// collision — `id`, `path`, `raw`, `hash`, `updated_at`, `created_at` on docs
|
|
64
|
+
// and blocks, `title`/`tags` on docs, `id`/`path` on nodes and edges) → a param-free SQL
|
|
65
65
|
// scalar, per target, with its kind. The structural columns and foreign keys are
|
|
66
66
|
// translated in `translateOperand`. Anything not mapped (`raw`, reconstructed or
|
|
67
67
|
// a blob; `title`, computed; `tags`, the union of the authored list and the
|
|
68
68
|
// computed hashtags) returns null → residual, and the caller must NOT fall
|
|
69
69
|
// through to a property read of the same name (the attribute wins in memory).
|
|
70
|
-
// `updated_at`
|
|
70
|
+
// `updated_at` and `created_at` (4.10) are correlated subqueries over the
|
|
71
|
+
// document's revisions (`current_rev` / `seq = 1`); a block's are residual, as
|
|
72
|
+
// before. `path` (and the edge field `dst_path`)
|
|
71
73
|
// is the REFERENCE form on the surface (spec/surface §1 "Paths", 2.0) — `'/' ||
|
|
72
74
|
// <storage column>` in SQL — so every comparison, `startsWith`, `contains`,
|
|
73
75
|
// `lower()`… sees exactly the string the in-memory attribute yields;
|
|
@@ -79,8 +81,8 @@ export function pathColumn(col) {
|
|
|
79
81
|
/** The identity/bytes/time attributes per kind — the names `attributeSql` owns
|
|
80
82
|
* (the structural columns are handled per target in `translateOperand`). */
|
|
81
83
|
export const ROW_ATTRIBUTES = {
|
|
82
|
-
docs: new Set(["id", "path", "raw", "hash", "updated_at", "title", "tags"]),
|
|
83
|
-
blocks: new Set(["id", "path", "raw", "hash", "updated_at"]),
|
|
84
|
+
docs: new Set(["id", "path", "raw", "hash", "updated_at", "created_at", "title", "tags"]),
|
|
85
|
+
blocks: new Set(["id", "path", "raw", "hash", "updated_at", "created_at"]),
|
|
84
86
|
nodes: new Set(["id", "path"]),
|
|
85
87
|
links: new Set(["id", "path"]),
|
|
86
88
|
};
|
|
@@ -93,6 +95,7 @@ function attributeSql(name, ctx) {
|
|
|
93
95
|
case "path": return pathColumn(`${doc}.path`);
|
|
94
96
|
case "hash": return text(`lower(hex(${self}.file_hash))`);
|
|
95
97
|
case "updated_at": return text(`(SELECT c.ts FROM revisions r JOIN commits c ON c.commit_id = r.commit_id WHERE r.rev_id = ${self}.current_rev)`);
|
|
98
|
+
case "created_at": return text(`(SELECT c.ts FROM revisions r JOIN commits c ON c.commit_id = r.commit_id WHERE r.doc_id = ${self}.doc_id AND r.seq = 1)`);
|
|
96
99
|
}
|
|
97
100
|
else if (target === "blocks")
|
|
98
101
|
switch (name) {
|
|
@@ -300,6 +303,8 @@ export function translateOperand(e, ctx) {
|
|
|
300
303
|
return text(`lower(hex(${doc}.file_hash))`);
|
|
301
304
|
if (k === "updated_at")
|
|
302
305
|
return text(`(SELECT c.ts FROM revisions r JOIN commits c ON c.commit_id = r.commit_id WHERE r.rev_id = ${doc}.current_rev)`);
|
|
306
|
+
if (k === "created_at")
|
|
307
|
+
return text(`(SELECT c.ts FROM revisions r JOIN commits c ON c.commit_id = r.commit_id WHERE r.doc_id = ${doc}.doc_id AND r.seq = 1)`);
|
|
303
308
|
if (k === "format")
|
|
304
309
|
return text(`${doc}.format`);
|
|
305
310
|
if (k.startsWith("$"))
|
|
@@ -334,6 +339,8 @@ export function translateOperand(e, ctx) {
|
|
|
334
339
|
return probe("lower(hex(dd.file_hash))");
|
|
335
340
|
if (k === "updated_at")
|
|
336
341
|
return probe("(SELECT c.ts FROM revisions r JOIN commits c ON c.commit_id = r.commit_id WHERE r.rev_id = dd.current_rev)");
|
|
342
|
+
if (k === "created_at")
|
|
343
|
+
return probe("(SELECT c.ts FROM revisions r JOIN commits c ON c.commit_id = r.commit_id WHERE r.doc_id = dd.doc_id AND r.seq = 1)");
|
|
337
344
|
if (k === "format")
|
|
338
345
|
return probe("dd.format");
|
|
339
346
|
if (k.startsWith("$"))
|
|
@@ -79,7 +79,7 @@ function probeFor(target, path) {
|
|
|
79
79
|
// relation / handle (`out_links`, `data`, `frontmatter`, …), not the `format` column
|
|
80
80
|
// (not indexed), not an OQX `$` name, and of the engine attributes only
|
|
81
81
|
// `title` (the computed `$title` row, a scalar property the author's `title:`
|
|
82
|
-
// never reaches — `data.title` does): `raw`, `hash`, `updated_at` and `tags`
|
|
82
|
+
// never reaches — `data.title` does): `raw`, `hash`, `updated_at`, `created_at` and `tags`
|
|
83
83
|
// (authored ∪ hashtags) have no index and are never property probes.
|
|
84
84
|
if (key === "title")
|
|
85
85
|
return { kind: "property", key: "$title", source: "computed" };
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export declare const SPEC_VERSIONS: {
|
|
2
|
-
readonly oqx: "0.
|
|
2
|
+
readonly oqx: "0.25";
|
|
3
3
|
readonly format: "0.2";
|
|
4
4
|
readonly reconcile: "2.3";
|
|
5
5
|
readonly store: "15.0";
|
|
@@ -8,7 +8,7 @@ export declare const SPEC_VERSIONS: {
|
|
|
8
8
|
readonly search: "2.0";
|
|
9
9
|
readonly mutate: "3.5";
|
|
10
10
|
readonly sync: "2.2";
|
|
11
|
-
readonly surface: "4.
|
|
11
|
+
readonly surface: "4.10";
|
|
12
12
|
readonly cli: "4.6";
|
|
13
13
|
};
|
|
14
14
|
export type SpecName = keyof typeof SPEC_VERSIONS;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@omgbase/core",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.24.0",
|
|
4
4
|
"description": "Open Markdown Graph Base — embedded engine",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -55,7 +55,7 @@
|
|
|
55
55
|
},
|
|
56
56
|
"dependencies": {
|
|
57
57
|
"@modelcontextprotocol/sdk": "^1.30.0",
|
|
58
|
-
"@omgbase/oqx": "^0.
|
|
58
|
+
"@omgbase/oqx": "^0.25.0",
|
|
59
59
|
"better-sqlite3": "^13.0.3",
|
|
60
60
|
"mdast-util-from-markdown": "^2.0.2",
|
|
61
61
|
"mdast-util-frontmatter": "^2.0.1",
|