Interface: PropertyGraphExecuteResponse
@kortexya/reasoninglayer / PropertyGraphExecuteResponse
Interface: PropertyGraphExecuteResponse
Section titled “Interface: PropertyGraphExecuteResponse”Defined in: src/types/property-graph.ts:77
Execution result for a GQL/Cypher/Gremlin query after lowering to OSFQL.
Remarks
Section titled “Remarks”Bindings use the tagged PropertyGraphValue format.
osfql exposes the exact OSFQL program the server executed, which makes the
lowering auditable; notes explains any compatibility compromises made while
lowering the source language.
Example
Section titled “Example”const result = await client.propertyGraph.executeCypher('MATCH (p:person) RETURN p');console.log(result.language); // "cypher"console.log(result.operation); // "read"console.log(result.osfql); // "MATCH person(...);"Properties
Section titled “Properties”bindings
Section titled “bindings”bindings:
Record<string,OsfqlValue>[]
Defined in: src/types/property-graph.ts:91
Variable bindings returned by the lowered OSFQL MATCH. One entry per solution.
definedSortIds
Section titled “definedSortIds”definedSortIds:
string[]
Defined in: src/types/property-graph.ts:97
Sort IDs produced by DEFINE; normally empty for property-graph compatibility.
diagnostics
Section titled “diagnostics”diagnostics:
string[]
Defined in: src/types/property-graph.ts:100
Diagnostics emitted by the OSFQL executor.
language
Section titled “language”language:
string
Defined in: src/types/property-graph.ts:82
Source language: "gql", "cypher", or "gremlin".
notes:
string[]
Defined in: src/types/property-graph.ts:103
Compatibility notes explaining the lowering.
operation
Section titled “operation”operation:
string
Defined in: src/types/property-graph.ts:85
Operation kind: "read" or "write".
osfql:
string
Defined in: src/types/property-graph.ts:88
The OSFQL program that was executed.
producedTermIds
Section titled “producedTermIds”producedTermIds:
string[]
Defined in: src/types/property-graph.ts:94
Term IDs produced by mutating OSFQL statements.
statementCount
Section titled “statementCount”statementCount:
number
Defined in: src/types/property-graph.ts:106
Number of OSFQL statements executed.
success
Section titled “success”success:
boolean
Defined in: src/types/property-graph.ts:79
Whether execution succeeded.