Class UserCustomResultSet

User Custom Result Set to wrap a database ResultSet for tile queries

Hierarchy

UserResultSet<UserCustomColumn, UserCustomTable, UserCustomRow>
- UserCustomResultSet

Constructors

constructor

new UserCustomResultSet(table: UserCustomTable, columns: string[] | UserColumns<UserCustomColumn>, resultSet: ResultSet, sql: string, selectionArgs: any[]): UserCustomResultSet
Constructor
Parameters
- table: UserCustomTable
  
  user custom table
- columns: string[] | UserColumns<UserCustomColumn>
  
  columns
- resultSet: ResultSet
  
  result set
- sql: string
  
  SQL statement
- selectionArgs: any[]
  
  selection arguments
Returns UserCustomResultSet
Overrides UserResultSet.constructor
- Defined in lib/user/custom/userCustomResultSet.ts:23

Properties

`Protected` resultSet

resultSet: ResultSet

Result Set

Methods

[iterator]

[iterator](): IterableIterator<UserCustomRow>
Returns IterableIterator<UserCustomRow>
Inherited from UserResultSet.[iterator]
- Defined in lib/user/userResultSet.ts:224

close

close(): void
Inherit Doc

Returns void
Inherited from UserResultSet.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
Inherited from UserResultSet.getBuffer
- Defined in lib/db/resultSetResult.ts:132

getColumnCount

getColumnCount(): number
Get the number of columns

Returns
column count

Returns number
Inherited from UserResultSet.getColumnCount
- Defined in lib/db/resultSetResult.ts:80

getColumnNames

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

Returns
column names

Returns string[]
Inherited from UserResultSet.getColumnNames
- Defined in lib/db/resultSetResult.ts:93

getColumns

getColumns(): UserCustomColumns
Get the columns

Returns
columns

Returns UserCustomColumns
Overrides UserResultSet.getColumns
- Defined in lib/user/custom/userCustomResultSet.ts:45

getCount

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

Returns
count

Returns number
Inherited from UserResultSet.getCount
- Defined in lib/user/userResultSet.ts:213

getId

getId(): number
Get the id

Returns
the id

Returns number
Inherited from UserResultSet.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
Inherited from UserResultSet.getNumber
- Defined in lib/db/resultSetResult.ts:119

getResultSet

getResultSet(): ResultSet
Get the Result Set

Returns
result set

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

getRow

getRow(): UserCustomRow
Get the row

Returns
row

Returns UserCustomRow
Inherited from UserResultSet.getRow
- Defined in lib/user/userResultSet.ts:188

getRowWithColumnTypesAndValues

getRowWithColumnTypesAndValues(columnTypes: number[], values: DBValue[]): UserCustomRow
Get row with column types and values
Parameters
- columnTypes: number[]
- values: DBValue[]
Returns UserCustomRow
Overrides UserResultSet.getRowWithColumnTypesAndValues
- Defined in lib/user/custom/userCustomResultSet.ts:38

getSelectionArgs

getSelectionArgs(): any[]
Get the sql arguments

Returns
args

Returns any[]
Inherited from UserResultSet.getSelectionArgs
- Defined in lib/user/userResultSet.ts:254

getSql

getSql(): string
Get the sql

Returns
sql

Returns string
Inherited from UserResultSet.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
Inherited from UserResultSet.getString
- Defined in lib/db/resultSetResult.ts:106

getTable

getTable(): UserCustomTable
Get the table

Returns
table

Returns UserCustomTable
Inherited from UserResultSet.getTable
- Defined in lib/user/userResultSet.ts:164

getTableName

getTableName(): string
Get the table name

Returns
table name

Returns string
Inherited from UserResultSet.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
Inherited from UserResultSet.getValue
- Defined in lib/db/resultSetResult.ts:40

getValueForColumn

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

Returns
Parameters
- column: UserCustomColumn
Returns any
Inherited from UserResultSet.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
Inherited from UserResultSet.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
Inherited from UserResultSet.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
Inherited from UserResultSet.getValueWithIndex
- Defined in lib/db/resultSetResult.ts:53

ids

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

Returns IterableIterator<number>
Inherited from UserResultSet.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
Inherited from UserResultSet.moveToNext
- Defined in lib/db/resultSetResult.ts:67

next(): {
done: boolean;
value: UserCustomRow;
}
Returns {
done: boolean;
value: UserCustomRow;
}
- done: boolean
- value: UserCustomRow
Inherited from UserResultSet.next
- Defined in lib/user/userResultSet.ts:228

wasNull

wasNull(): boolean
Was the last value retrieved null

Returns
true if was null

Returns boolean
Inherited from UserResultSet.wasNull
- Defined in lib/db/resultSetResult.ts:145

Class UserCustomResultSet

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

table: UserCustomTable

columns: string[] | UserColumns<UserCustomColumn>

resultSet: ResultSet

sql: string

selectionArgs: any[]

Returns UserCustomResultSet

Properties

Protected resultSet

Methods

[iterator]

Returns IterableIterator<UserCustomRow>

close

Inherit Doc

Returns void

getBuffer

Returns

Parameters

columnName: string

Returns Buffer

getColumnCount

Returns

Returns number

getColumnNames

Returns

Returns string[]

getColumns

Returns

Returns UserCustomColumns

getCount

Returns

Returns number

getId

Returns

Returns number

getNumber

Returns

Parameters

columnName: string

Returns number

getResultSet

Returns

Returns ResultSet

getRow

Returns

Returns UserCustomRow

getRowWithColumnTypesAndValues

Parameters

columnTypes: number[]

values: DBValue[]

Returns UserCustomRow

getSelectionArgs

Returns

Returns any[]

getSql

Returns

Returns string

getString

Returns

Parameters

columnName: string

Returns string

getTable

Returns

Returns UserCustomTable

getTableName

Returns

Returns string

getValue

Parameters

columnName: string

Optional dataType: GeoPackageDataType

`Protected` resultSet

`Optional` dataType: GeoPackageDataType

Returns {
done: boolean;
value: UserCustomRow;
}