Class UserResultSet<TColumn, TTable, TRow>`Abstract`

Abstract User Result Set. The column index of the GeoPackage core is 0 indexed based and ResultSets are 1 indexed based.

Type Parameters

TColumn extends UserColumn

column type
TTable extends UserTable<TColumn>

table type
TRow extends UserRow<TColumn, TTable>

row type

Hierarchy

ResultSetResult
- UserResultSet

Implements

UserResult<TColumn, TTable, TRow>

Constructors

`Protected` constructor

new UserResultSet<TColumn, TTable, TRow>(table: TTable, columns: string[] | UserColumns<TColumn>, resultSet: ResultSet, sql: string, selectionArgs: any[]): UserResultSet<TColumn, TTable, TRow>
Protected
Constructor
Type Parameters
- TColumn extends UserColumn<TColumn>
- TTable extends UserTable<TColumn, TTable>
- TRow extends UserRow<TColumn, TTable, TRow>
Parameters
- table: TTable
- columns: string[] | UserColumns<TColumn>
- resultSet: ResultSet
- sql: string
- selectionArgs: any[]
Returns UserResultSet<TColumn, TTable, TRow>
Overrides ResultSetResult.constructor
- Defined in lib/user/userResultSet.ts:64

Properties

`Protected` resultSet

resultSet: ResultSet

Result Set

Methods

[iterator]

[iterator](): IterableIterator<TRow>
Returns IterableIterator<TRow>
Implementation of UserResult.[iterator]
- Defined in lib/user/userResultSet.ts:224

close

close(): void
Inherit Doc

Returns void
Inherited from ResultSetResult.close
- Defined in lib/db/resultSetResult.ts:156

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
Implementation of UserResult.getBuffer

Inherited from ResultSetResult.getBuffer
- Defined in lib/db/resultSetResult.ts:132

getColumnCount

getColumnCount(): number
Get the number of columns

Returns
column count

Returns number
Implementation of UserResult.getColumnCount

Inherited from ResultSetResult.getColumnCount
- Defined in lib/db/resultSetResult.ts:80

getColumnNames

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

Returns
column names

Returns string[]
Implementation of UserResult.getColumnNames

Inherited from ResultSetResult.getColumnNames
- Defined in lib/db/resultSetResult.ts:93

getColumns

getColumns(): UserColumns<TColumn>
Get the columns

Returns
columns

Returns UserColumns<TColumn>
Implementation of UserResult.getColumns
- Defined in lib/user/userResultSet.ts:180

getCount

getCount(): number
Get a count of the records in this result set

Returns
count

Returns number
Implementation of UserResult.getCount
- Defined in lib/user/userResultSet.ts:213

getId

getId(): number
Get the id

Returns
the id

Returns number
Implementation of UserResult.getId
- Defined in lib/user/userResultSet.ts:123

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
Implementation of UserResult.getNumber

Inherited from ResultSetResult.getNumber
- Defined in lib/db/resultSetResult.ts:119

getResultSet

getResultSet(): ResultSet
Get the Result Set

Returns
result set

Returns ResultSet
Inherited from ResultSetResult.getResultSet
- Defined in lib/db/resultSetResult.ts:30

getRow

getRow(): TRow
Get the row

Returns
row

Returns TRow
Implementation of UserResult.getRow
- Defined in lib/user/userResultSet.ts:188

getRowWithColumnTypesAndValues

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

Returns
a user row
Parameters
- columnTypes: number[]
- values: any[]
Returns TRow
Implementation of UserResult.getRowWithColumnTypesAndValues
- Defined in lib/user/userResultSet.ts:88

getSelectionArgs

getSelectionArgs(): any[]
Get the sql arguments

Returns
args

Returns any[]
Implementation of UserResult.getSelectionArgs
- Defined in lib/user/userResultSet.ts:254

getSql

getSql(): string
Get the sql

Returns
sql

Returns string
Implementation of UserResult.getSql
- Defined in lib/user/userResultSet.ts:246

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
Implementation of UserResult.getString

Inherited from ResultSetResult.getString
- Defined in lib/db/resultSetResult.ts:106

getTable

getTable(): TTable
Get the table

Returns
table

Returns TTable
Implementation of UserResult.getTable
- Defined in lib/user/userResultSet.ts:164

getTableName

getTableName(): string
Get the table name

Returns
table name

Returns string
Implementation of UserResult.getTableName
- Defined in lib/user/userResultSet.ts:172

getValue

getValue(columnName: string, dataType?: GeoPackageDataType): any
Get the value
Parameters
- columnName: string
- Optional dataType: GeoPackageDataType
Returns any
Implementation of UserResult.getValue

Inherited from ResultSetResult.getValue
- Defined in lib/db/resultSetResult.ts:40

getValueForColumn

getValueForColumn(column: TColumn): any
Gets the value for a given column

Returns
Parameters
- column: TColumn
Returns any
Implementation of UserResult.getValueForColumn
- Defined in lib/user/userResultSet.ts:97

getValueForColumnName

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

Returns
Parameters
- columnName: string
Returns any
Implementation of UserResult.getValueForColumnName
- Defined in lib/user/userResultSet.ts:115

getValueForIndex

getValueForIndex(index: number): any
Gets the value for a given index

Returns
Parameters
- index: number
Returns any
Implementation of UserResult.getValueForIndex
- Defined in lib/user/userResultSet.ts:106

getValueWithIndex

getValueWithIndex(columnIdx: number): any
Gets the value at the index provided
Parameters
- columnIdx: number
Returns any
Implementation of UserResult.getValueWithIndex

Inherited from ResultSetResult.getValueWithIndex
- Defined in lib/db/resultSetResult.ts:53

ids

ids(): IterableIterator<number>
Get an iterator for id values

Returns IterableIterator<number>
Implementation of UserResult.ids
- Defined in lib/user/userResultSet.ts:279

moveToNext

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

Returns
true if another row

Returns boolean
Implementation of UserResult.moveToNext

Inherited from ResultSetResult.moveToNext
- Defined in lib/db/resultSetResult.ts:67

next(): {
done: boolean;
value: TRow;
}
Returns {
done: boolean;
value: TRow;
}
- done: boolean
- value: TRow
Implementation of UserResult.next
- Defined in lib/user/userResultSet.ts:228

wasNull

wasNull(): boolean
Was the last value retrieved null

Returns
true if was null

Returns boolean
Implementation of UserResult.wasNull

Inherited from ResultSetResult.wasNull
- Defined in lib/db/resultSetResult.ts:145

Class UserResultSet<TColumn, TTable, TRow>Abstract

Type Parameters

TColumn extends UserColumn

TTable extends UserTable<TColumn>

TRow extends UserRow<TColumn, TTable>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Type Parameters

TColumn extends UserColumn<TColumn>

TTable extends UserTable<TColumn, TTable>

TRow extends UserRow<TColumn, TTable, TRow>

Parameters

table: TTable

columns: string[] | UserColumns<TColumn>

resultSet: ResultSet

sql: string

selectionArgs: any[]

Returns UserResultSet<TColumn, TTable, TRow>

Properties

Protected resultSet

Methods

[iterator]

Returns IterableIterator<TRow>

close

Inherit Doc

Returns void

getBuffer

Returns

Parameters

columnName: string

Returns Buffer

getColumnCount

Returns

Returns number

getColumnNames

Returns

Returns string[]

getColumns

Returns

Returns UserColumns<TColumn>

getCount

Returns

Returns number

getId

Returns

Returns number

getNumber

Returns

Parameters

columnName: string

Returns number

getResultSet

Returns

Returns ResultSet

getRow

Returns

Returns TRow

getRowWithColumnTypesAndValues

Returns

Parameters

columnTypes: number[]

values: any[]

Returns TRow

getSelectionArgs

Returns

Returns any[]

getSql

Returns

Returns string

getString

Returns

Parameters

columnName: string

Returns string

Class UserResultSet<TColumn, TTable, TRow>`Abstract`

`Protected` constructor

`Protected` resultSet

`Optional` dataType: GeoPackageDataType

Returns {
done: boolean;
value: TRow;
}