Interface: PropertyGraphExecuteResponse

@kortexya/reasoninglayer / PropertyGraph / PropertyGraphExecuteResponse

Interface: PropertyGraphExecuteResponse

Defined in: src/types/property-graph.ts:77

Execution result for a GQL/Cypher/Gremlin query after lowering to OSFQL.

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

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

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

definedSortIds: string[]

Defined in: src/types/property-graph.ts:97

Sort IDs produced by DEFINE; normally empty for property-graph compatibility.

diagnostics

diagnostics: string[]

Defined in: src/types/property-graph.ts:100

Diagnostics emitted by the OSFQL executor.

language

language: string

Defined in: src/types/property-graph.ts:82

Source language: "gql", "cypher", or "gremlin".

notes

notes: string[]

Defined in: src/types/property-graph.ts:103

Compatibility notes explaining the lowering.

operation

operation: string

Defined in: src/types/property-graph.ts:85

Operation kind: "read" or "write".

osfql

osfql: string

Defined in: src/types/property-graph.ts:88

The OSFQL program that was executed.

producedTermIds

producedTermIds: string[]

Defined in: src/types/property-graph.ts:94

Term IDs produced by mutating OSFQL statements.

statementCount

statementCount: number

Defined in: src/types/property-graph.ts:106

Number of OSFQL statements executed.

success

success: boolean

Defined in: src/types/property-graph.ts:79

Whether execution succeeded.