Interface UserResult<TColumn, TTable, TRow>

Abstract User Cursor

Type Parameters

TColumn extends UserColumn

column type
TTable extends UserTable<TColumn>

table type
TRow extends UserRow<TColumn, TTable>

row type

Hierarchy

Result
IterableIterator<TRow>
- UserResult

Implemented by

UserResultSet

Methods

[iterator]

[iterator](): IterableIterator<TRow>
Returns IterableIterator<TRow>
Inherited from IterableIterator.__@iterator@65
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:55

getBuffer

getBuffer(columnName: string): Buffer
Returns the value of the requested column as a byte array.

Returns
bytes value
Parameters
- columnName: string
  
  column name
Returns Buffer
Inherited from Result.getBuffer
- Defined in lib/db/result.ts:56

getColumnCount

getColumnCount(): number
Get the number of columns

Returns
column count

Returns number
Inherited from Result.getColumnCount
- Defined in lib/db/result.ts:25

getColumnNames

getColumnNames(): string[]
Get the name of the columns

Returns
column names

Returns string[]
Inherited from Result.getColumnNames
- Defined in lib/db/result.ts:32

getColumns

getColumns(): UserColumns<TColumn>
Get the columns

Returns
columns

Returns UserColumns<TColumn>
- Defined in lib/user/userResult.ts:76

getCount

getCount(connection: GeoPackageConnection): number
Get the count of results

Returns
count, -1 if not able to determine
Parameters
- connection: GeoPackageConnection
Returns number
- Defined in lib/user/userResult.ts:90

getId

getId(): number
Get the primary key value

Returns
value

Returns number
- Defined in lib/user/userResult.ts:55

getNumber

getNumber(columnName: string): number
Returns the value of the requested column as an int.

Returns
int value
Parameters
- columnName: string
  
  column name
Returns number
Inherited from Result.getNumber
- Defined in lib/db/result.ts:48

getRow

getRow(): TRow
Get the row at the current cursor position

Returns
row

Returns TRow
- Defined in lib/user/userResult.ts:83

getRowWithColumnTypesAndValues

getRowWithColumnTypesAndValues(columnTypes: number[], values: any[]): TRow
Get a row using the column types and values

Returns
row
Parameters
- columnTypes: number[]
  
  column types
- values: any[]
  
  values
Returns TRow
- Defined in lib/user/userResult.ts:27

getSelectionArgs

getSelectionArgs(): any[]
Get the SQL selection arguments (if available)

Returns
selection arguments

Returns any[]
- Defined in lib/user/userResult.ts:104

getSql

getSql(): string
Get the SQL statement (if available)

Returns
SQL statement

Returns string
- Defined in lib/user/userResult.ts:97

getString

getString(columnName: string): string
Returns the value of the requested column as a String.

Returns
string value
Parameters
- columnName: string
  
  column name
Returns string
Inherited from Result.getString
- Defined in lib/db/result.ts:40

getTable

getTable(): TTable
Get the table

Returns
table

Returns TTable
- Defined in lib/user/userResult.ts:62

getTableName

getTableName(): string
Get the table name

Returns
table name

Returns string
- Defined in lib/user/userResult.ts:69

getValue

getValue(columnName: string): any
Get the value for the column

Returns
value
Parameters
- columnName: string
Returns any
Inherited from Result.getValue
- Defined in lib/db/result.ts:11

getValueForColumn

getValueForColumn(column: TColumn): any
Get the value for the column

Returns
value
Parameters
- column: TColumn
  
  column
Returns any
- Defined in lib/user/userResult.ts:34

getValueForColumnName

getValueForColumnName(columnName: string): any
Get the value for the column name

Returns
value
Parameters
- columnName: string
  
  column name
Returns any
- Defined in lib/user/userResult.ts:48

getValueForIndex

getValueForIndex(index: number): any
Get the value for the column index

Returns
value
Parameters
- index: number
  
  column index
Returns any
- Defined in lib/user/userResult.ts:41

getValueWithIndex

getValueWithIndex(columnIdx: number): any
Gets the value at the index provided
Parameters
- columnIdx: number
Returns any
Inherited from Result.getValueWithIndex
- Defined in lib/db/result.ts:69

ids

ids(): IterableIterator<number>
Iterable for iterating over result ids in place of rows

Returns
iterable ids

Returns IterableIterator<number>
- Defined in lib/user/userResult.ts:111

moveToNext

moveToNext(): boolean
Move the cursor to the next row.

Returns
true if another row

Returns boolean
Inherited from Result.moveToNext
- Defined in lib/db/result.ts:18

next

next(...args: [] | [undefined]): IteratorResult<TRow, any>
Parameters
- Rest ...args: [] | [undefined]
Returns IteratorResult<TRow, any>
Inherited from IterableIterator.next
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:45

`Optional` return

return(value?: any): IteratorResult<TRow, any>
Parameters
- Optional value: any
Returns IteratorResult<TRow, any>
Inherited from IterableIterator.return
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:46

`Optional` throw

throw(e?: any): IteratorResult<TRow, any>
Parameters
- Optional e: any
Returns IteratorResult<TRow, any>
Inherited from IterableIterator.throw
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:47

wasNull

wasNull(): boolean
Was the last value retrieved null

Returns
true if was null

Returns boolean
Inherited from Result.wasNull
- Defined in lib/db/result.ts:63

Generated using TypeDoc