Skip to content
KortexyaKortexyaReasoning Layer SDK

Interface: OsfqlFailure

@kortexya/reasoninglayer

@kortexya/reasoninglayer / OsfqlFailure

Interface: OsfqlFailure

Section titled “Interface: OsfqlFailure”

Defined in: src/types/osfql.ts:1169

The parsed body of an OSFQL failure, carried by OsfqlError.

Remarks

Section titled “Remarks”

Parsed from the raw snake_case OsfqlErrorResponse (error_type, message, refusal, max_rows, sort_delete_refusal, atomic_refusal). A timeout body is not represented here: it throws DeadlineExceededError.

Example

Section titled “Example”
const failure: OsfqlFailure = {
  errorType: 'row_cap',
  message: 'OSFQL row cap exceeded: …',
  maxRows: 1000,
};

Properties

Section titled “Properties”

atomicRefusal?

Section titled “atomicRefusal?”

optional atomicRefusal?: OsfqlAtomicRefusal

Defined in: src/types/osfql.ts:1189

Why the program was refused before anything ran (errorType: 'refused', HTTP 400): a DROP SORT or an ALTER SORT … PARENTS beside another statement. The same code OsfqlPreviewResponse.atomicRefusal reports.

errorType

Section titled “errorType”

errorType: OsfqlErrorType

Defined in: src/types/osfql.ts:1171

The class of the failure.

maxRows?

Section titled “maxRows?”

optional maxRows?: number

Defined in: src/types/osfql.ts:1177

The row cap the program ran under. Present only with errorType: 'row_cap'.

message

Section titled “message”

message: string

Defined in: src/types/osfql.ts:1173

The engine’s own sentence.

refusal?

Section titled “refusal?”

optional refusal?: OsfqlRefusal

Defined in: src/types/osfql.ts:1175

The typed write refusal, when the failure is one.

sortDeleteRefusal?

Section titled “sortDeleteRefusal?”

optional sortDeleteRefusal?: SortDeleteRefusalDto

Defined in: src/types/osfql.ts:1182

Why a DROP SORT was refused (errorType: 'refused'): the same coded refusal the REST sort delete answers, with its HTTP status.