Interface: PropertyGraphTranslateResponse

@kortexya/reasoninglayer / PropertyGraph / PropertyGraphTranslateResponse

Interface: PropertyGraphTranslateResponse

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

Translate-only result for a GQL/Cypher/Gremlin query.

Remarks

Returned by the /translate endpoints, which lower the query to OSFQL and return the program without executing it. Useful for migration audits and for inspecting how a property-graph query maps onto OSF.

Example

const translated = await client.propertyGraph.translateGremlin('g.V().hasLabel("person")');
console.log(translated.osfql);  // the OSFQL program the server would run

Properties

language

language: string

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

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

notes

notes: string[]

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

Compatibility notes explaining the lowering.

operation

operation: string

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

Operation kind: "read" or "write".

osfql

osfql: string

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

The OSFQL program the server would execute.