Class OINODataSet`Abstract`

Base class for SQL results that can be asynchronously iterated (but not necessarity rewinded). Idea is to handle database specific mechanisms for returning and formatting conventions in the database specific implementation. Data might be in memory or streamed in chunks and OINODataSet will serve it out consistently.

Hierarchy (View Summary)

OINOResult
- OINODataSet
  - OINOMemoryDataset

Index

Constructors

constructor

new OINODataSet(data: unknown, messages?: string[]): OINODataSet
Constructor for OINODataSet.
Parameters
- data: unknown
  internal database specific data type (constructor will throw if invalid)
- messages: string[] = []
  error messages from SQL-query
Returns OINODataSet
Overrides OINOResult.constructor
- Defined in common/src/OINODataSource.ts:102

Properties

`Readonly`messages

messages: string[]

Error messages

status

status: number

HTTP status code

statusText

statusText: string

HTTP status message

success

success: boolean

Wheter request was successfully executed

Methods

addDebug

addDebug(message: string, operation: string): OINOResult
Add debug message. Returns self reference for chaining.
Parameters
- message: string
  HTTP status message
- operation: string
  operation where debug occured
Returns OINOResult
Inherited from OINOResult.addDebug
- Defined in common/src/OINOResult.ts:131

addInfo

addInfo(message: string, operation: string): OINOResult
Add info message. Returns self reference for chaining.
Parameters
- message: string
  HTTP status message
- operation: string
  operation where info occured
Returns OINOResult
Inherited from OINOResult.addInfo
- Defined in common/src/OINOResult.ts:116

addWarning

addWarning(message: string, operation: string): OINOResult
Add warning message. Returns self reference for chaining.
Parameters
- message: string
  HTTP status message
- operation: string
  operation where warning occured
Returns OINOResult
Inherited from OINOResult.addWarning
- Defined in common/src/OINOResult.ts:101

copy

copy(result: OINOResult): void
Copy values from different result.
Parameters
- result: OINOResult
  source value
Returns void
Inherited from OINOResult.copy
- Defined in common/src/OINOResult.ts:55

copyMessagesToHeaders

copyMessagesToHeaders(
    headers: OINOHeaders,
    copyErrors?: boolean,
    copyWarnings?: boolean,
    copyInfos?: boolean,
    copyDebug?: boolean,
): void
Copy given messages to HTTP headers.
Parameters
- headers: OINOHeaders
  HTTP headers
- copyErrors: boolean = true
  wether error messages should be copied (default true)
- copyWarnings: boolean = false
  wether warning messages should be copied (default false)
- copyInfos: boolean = false
  wether info messages should be copied (default false)
- copyDebug: boolean = false
  wether debug messages should be copied (default false)
Returns void
Inherited from OINOResult.copyMessagesToHeaders
- Defined in common/src/OINOResult.ts:149

`Abstract`getAllRows

getAllRows(): Promise<OINODataRow[]>
Gets all rows of data.

NOTE: This is left abstract instead of just using getRow() so that DB implementations can hopefully optimize not duplicating data *

Returns Promise<OINODataRow[]>
- Defined in common/src/OINODataSource.ts:138

getFirstError

getFirstError(): string
Finds the first error message that occured

Returns string
- Defined in common/src/OINODataSource.ts:157

getLastError

getLastError(): string
Finds the last error message that occured

Returns string
- Defined in common/src/OINODataSource.ts:170

`Abstract`getRow

getRow(): OINODataRow
Gets current row of data.

Returns OINODataRow
- Defined in common/src/OINODataSource.ts:131

hasErrors

hasErrors(): boolean
Checks if the messages contain errors.

Returns boolean
- Defined in common/src/OINODataSource.ts:144

`Abstract`isEmpty

isEmpty(): boolean
Is data set empty.

Returns boolean
- Defined in common/src/OINODataSource.ts:113

`Abstract`isEof

isEof(): boolean
Is there no more content, i.e. either dataset is empty or we have moved beyond last line

Returns boolean
- Defined in common/src/OINODataSource.ts:119

`Abstract`next

next(): Promise<boolean>
Attempts to moves dataset to the next row, possibly waiting for more data to become available. Returns !isEof().

Returns Promise<boolean>
- Defined in common/src/OINODataSource.ts:125

printLog

printLog(): string
Print result for logging.

Returns string
Inherited from OINOResult.printLog
- Defined in common/src/OINOResult.ts:176

setError

setError(status: number, statusText: string, operation: string): OINOResult
Set HTTP error status using given code and message. Returns self reference for chaining.
Parameters
- status: number
  HTTP status code
- statusText: string
  HTTP status message
- operation: string
  operation where error occured
Returns OINOResult
Inherited from OINOResult.setError
- Defined in common/src/OINOResult.ts:80

setOk

setOk(): void
Set HTTP OK status (does not reset messages).

Returns void
Inherited from OINOResult.setOk
- Defined in common/src/OINOResult.ts:66

Class OINODataSetAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns OINODataSet

Properties

Readonlymessages

status

statusText

success

Methods

addDebug

Parameters

Returns OINOResult

addInfo

Parameters

Returns OINOResult

addWarning

Parameters

Returns OINOResult

copy

Parameters

Returns void

copyMessagesToHeaders

Parameters

Returns void

AbstractgetAllRows

Returns Promise<OINODataRow[]>

getFirstError

Returns string

getLastError

Returns string

AbstractgetRow

Returns OINODataRow

hasErrors

Returns boolean

AbstractisEmpty

Returns boolean

AbstractisEof

Returns boolean

Abstractnext

Returns Promise<boolean>

printLog

Returns string

setError

Parameters

Returns OINOResult

setOk

Returns void

Settings

On This Page

Class OINODataSet`Abstract`

`Readonly`messages

`Abstract`getAllRows

`Abstract`getRow

`Abstract`isEmpty

`Abstract`isEof

`Abstract`next