Interface: OsfqlCatalogEntry
@kortexya/reasoninglayer / OsfqlCatalogEntry
Interface: OsfqlCatalogEntry
Section titled “Interface: OsfqlCatalogEntry”Defined in: src/types/osfql.ts:574
One entry of the OSFQL statement catalog — the engine’s own description of a statement it implements.
Remarks
Section titled “Remarks”⚠️ The enum-valued fields mix casing deliberately, and the SDK preserves it
verbatim. risk is snake_case (additive_write) because it is the same
value the generative-UI action surface reads back; family, category,
returns and both halves of uiAffinity are PascalCase (Query,
Read, Bindings, Table). Comparing them case-insensitively is safer than
assuming one convention.
Properties
Section titled “Properties”brief:
string
Defined in: src/types/osfql.ts:586
Summary of at most 120 characters.
category
Section titled “category”category:
string
Defined in: src/types/osfql.ts:582
Read | Write | Control | Meta (PascalCase).
examples
Section titled “examples”examples:
string[]
Defined in: src/types/osfql.ts:592
Parse-tested example(s).
execution
Section titled “execution”execution:
OsfqlCatalogExecution
Defined in: src/types/osfql.ts:610
How far the engine executes this statement.
family
Section titled “family”family:
string
Defined in: src/types/osfql.ts:580
Functional family, PascalCase (e.g. Query, Schema, Logic).
full:
string
Defined in: src/types/osfql.ts:588
Deeper description.
id:
string
Defined in: src/types/osfql.ts:576
Stable snake_case id, e.g. match, insert_bulk.
mutates
Section titled “mutates”mutates:
string
Defined in: src/types/osfql.ts:608
Whether this statement writes the store: never, always, or depends
when only the authored arguments can decide.
Remarks
Section titled “Remarks”category cannot answer this. CHAIN and RELEASE RESIDUATIONS are
Control and both write; MATCH is Read and writes whenever it carries
an inline clause. Read this field instead of keeping a table of which
process-control statements write.
depends is resolved by OsfqlClient.preview, whose per-statement
mutates is a concrete boolean. Copied verbatim, like risk.
needs:
string[]
Defined in: src/types/osfql.ts:620
Grounding ingredients the authoring stage must supply (e.g. Sort,
Features, Pattern). Empty means the statement genuinely needs none —
it is not a stand-in for “unknown”.
pitfalls
Section titled “pitfalls”pitfalls:
string[]
Defined in: src/types/osfql.ts:622
Known gotchas and engine caveats for this statement.
returns
Section titled “returns”returns:
string
Defined in: src/types/osfql.ts:614
Result shape, PascalCase (e.g. Bindings, Scalar, Path).
risk:
string
Defined in: src/types/osfql.ts:594
Safety tier, snake_case (e.g. read, additive_write).
statement
Section titled “statement”statement:
string
Defined in: src/types/osfql.ts:578
Exact AST variant name, e.g. Match, Bulk.
subOps
Section titled “subOps”subOps:
string[]
Defined in: src/types/osfql.ts:584
Sub-variant/operation names folded under this entry.
syntax
Section titled “syntax”syntax:
string
Defined in: src/types/osfql.ts:590
Canonical shape from the grammar.
uiAffinity
Section titled “uiAffinity”uiAffinity:
OsfqlCatalogUiAffinity
Defined in: src/types/osfql.ts:612
UI role — display and/or action.