Class QueryError

A statement or transaction failed. context.errorCode holds the code of the database or the driver: 'ORA-00001' (a unique constraint), or node-oracledb's own, such as 'NJS-040' (no free connection within pool.queueTimeout) or 'NJS-123' (callTimeout exceeded). For a database error context.errorNum holds its number (1 for ORA-00001) and context.oracleCode its code. The original error is cause.

Its code tells an HTTP handler (web-kit's response contract) how to answer: TIMEOUT (504) for NJS-123 and a DeadlineError, SERVICE_UNAVAILABLE (503) for NJS-040, CONFLICT (409) for ORA-00001, QUERY_ERROR (500) for the rest. The message stays server-side.

Hierarchy (View Summary)

IskraError
- QueryError

Index

Constructors

constructor

new QueryError(
message: string,
options?: ErrorOptions & { code?: ErrorCode },
): QueryError
Parameters
- message: string
- Optionaloptions: ErrorOptions & { code?: ErrorCode }
Returns QueryError
Overrides IskraError.constructor
- Defined in packages/db-oracle/src/errors.ts:31

Properties

`Readonly`code

code: ErrorCode

`Readonly`context

context: Record<string, unknown>

Accessors

applicationError

get applicationError(): { message: string; number: number } | undefined
A PL/SQL RAISE_APPLICATION_ERROR (ORA-20000 to ORA-20999): its number and message, without the ORA-20xxx: prefix and the ORA-06512 stack lines. Its code is CONFLICT (409), and the message is for the client.

Returns { message: string; number: number } | undefined
- Defined in packages/db-oracle/src/errors.ts:58

errorCode

get errorCode(): string | undefined
The database's or the driver's code: 'ORA-00001', 'NJS-040', 'NJS-123'…

Returns string | undefined
- Defined in packages/db-oracle/src/errors.ts:43

errorNum

get errorNum(): number | undefined
The ORA error number of the failure, if the database reported one.

Returns number | undefined
- Defined in packages/db-oracle/src/errors.ts:37

expose

get expose(): boolean
Whether web-kit shows the message to the client: a PL/SQL application error's.

Returns boolean
- Defined in packages/db-oracle/src/errors.ts:65

timedOut

get timedOut(): boolean
The statement ran out of time: node-oracledb's callTimeout (NJS-123) or the driver's deadline.

Returns boolean
- Defined in packages/db-oracle/src/errors.ts:49

Methods

toJSON

toJSON(): {
    cause?: string;
    code: ErrorCode;
    context: Record<string, unknown>;
    message: string;
    name: string;
}
Returns {
    cause?: string;
    code: ErrorCode;
    context: Record<string, unknown>;
    message: string;
    name: string;
}
Inherited from IskraError.toJSON
- Defined in packages/core/src/errors.ts:98

Class QueryError

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns QueryError

Properties

`Readonly`code

`Readonly`context

Accessors

applicationError

Returns { message: string; number: number } | undefined

errorCode

Returns string | undefined

errorNum

Returns number | undefined

expose

Returns boolean

timedOut

Returns boolean

Methods

toJSON

Returns {
    cause?: string;
    code: ErrorCode;
    context: Record<string, unknown>;
    message: string;
    name: string;
}

Settings

On This Page

Class QueryError

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns QueryError

Properties

Readonlycode

Readonlycontext

Accessors

applicationError

Returns { message: string; number: number } | undefined

errorCode

Returns string | undefined

errorNum

Returns number | undefined

expose

Returns boolean

timedOut

Returns boolean

Methods

toJSON

Returns { cause?: string; code: ErrorCode; context: Record<string, unknown>; message: string; name: string;}

Settings

On This Page

`Readonly`code

`Readonly`context

Returns {
cause?: string;
code: ErrorCode;
context: Record<string, unknown>;
message: string;
name: string;
}