Class UserConnection<TColumn, TTable, TRow, TResult>`Abstract`

GeoPackage Connection used to define common functionality within different connection types

Type Parameters

TColumn extends UserColumn

column type
TTable extends UserTable<TColumn>

table type
TRow extends UserRow<TColumn, TTable>

row type
TResult extends UserResultSet<TColumn, TTable, TRow>

result type

Hierarchy

UserConnection

Index

Constructors

`Protected` constructor

new UserConnection<TColumn, TTable, TRow, TResult>(connection: GeoPackageConnection): UserConnection<TColumn, TTable, TRow, TResult>
Constructor
Type Parameters
- TColumn extends UserColumn<TColumn>
- TTable extends UserTable<TColumn, TTable>
- TRow extends UserRow<TColumn, TTable, TRow>
- TResult extends UserResultSet<TColumn, TTable, TRow, TResult>
Parameters
- connection: GeoPackageConnection
  
  GeoPackage connection
Returns UserConnection<TColumn, TTable, TRow, TResult>
- Defined in lib/user/userConnection.ts:39

Properties

`Protected` `Readonly` connection

connection: GeoPackageConnection

Connection

`Protected` table

table: TTable

Table

Methods

count

count(distinct: boolean, tables: string, columns?: string[], where?: string, whereArgs?: [] | DBValue[], join?: string, groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): number
Perform query
Parameters
- distinct: boolean
- tables: string
- Optional columns: string[]
- Optional where: string
- Optional whereArgs: [] | DBValue[]
- Optional join: string
- Optional groupBy: string
- Optional having: string
- Optional orderBy: string
- Optional limit: number
- Optional offset: number
Returns number
- Defined in lib/user/userConnection.ts:141

countColumn

countColumn(table: string, distinct: boolean, column: string, where: string, args: any[]): number
Get a count of results

Returns
count
Parameters
- table: string
  
  table name
- distinct: boolean
  
  distinct column flag
- column: string
  
  column name
- where: string
  
  where clause
- args: any[]
  
  arguments
Returns number
- Defined in lib/user/userConnection.ts:172

`Protected` `Abstract` createResult

createResult(columns: string[], resultSet: ResultSet, sql: string, selectionArgs: string[]): TResult
Create a result by wrapping the ResultSet

Returns
result
Parameters
- columns: string[]
  
  result set
- resultSet: ResultSet
  
  result set
- sql: string
  
  SQL statement
- selectionArgs: string[]
  
  selection arguments
Returns TResult
- Defined in lib/user/userConnection.ts:67

getConnection

getConnection(): GeoPackageConnection
Get the connection

Returns GeoPackageConnection
- Defined in lib/user/userConnection.ts:213

getTable

getTable(): TTable
Get the table

Returns
table

Returns TTable
- Defined in lib/user/userConnection.ts:47

query

query(distinct: boolean, tables: string, columns?: string[], where?: string, whereArgs?: any[], join?: string, groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): TResult
Perform query
Parameters
- distinct: boolean
- tables: string
- Optional columns: string[]
- Optional where: string
- Optional whereArgs: any[]
- Optional join: string
- Optional groupBy: string
- Optional having: string
- Optional orderBy: string
- Optional limit: number
- Optional offset: number
Returns TResult
- Defined in lib/user/userConnection.ts:109

querySQL

querySQL(distinct: boolean, tables: string, columns?: string[], where?: string, join?: string, groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): string
Inherit Doc
Parameters
- distinct: boolean
- tables: string
- Optional columns: string[]
- Optional where: string
- Optional join: string
- Optional groupBy: string
- Optional having: string
- Optional orderBy: string
- Optional limit: number
- Optional offset: number
Returns string
- Defined in lib/user/userConnection.ts:184

rawQuery

rawQuery(sql: string, selectionArgs: []): TResult
Perform raw query
Parameters
- sql: string
- selectionArgs: []
Returns TResult
- Defined in lib/user/userConnection.ts:79

rawQueryWithColumns

rawQueryWithColumns(sql: string, columns: string[], selectionArgs: any[]): TResult
Perform raw query with specified columns
Parameters
- sql: string
- columns: string[]
- selectionArgs: any[]
Returns TResult
- Defined in lib/user/userConnection.ts:90

setTable

setTable(table: TTable): void
Set the table
Parameters
- table: TTable
  
  table
Returns void
- Defined in lib/user/userConnection.ts:55

Class UserConnection<TColumn, TTable, TRow, TResult>Abstract

Type Parameters

TColumn extends UserColumn

TTable extends UserTable<TColumn>

TRow extends UserRow<TColumn, TTable>

TResult extends UserResultSet<TColumn, TTable, TRow>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Type Parameters

TColumn extends UserColumn<TColumn>

TTable extends UserTable<TColumn, TTable>

TRow extends UserRow<TColumn, TTable, TRow>

TResult extends UserResultSet<TColumn, TTable, TRow, TResult>

Parameters

connection: GeoPackageConnection

Returns UserConnection<TColumn, TTable, TRow, TResult>

Properties

Protected Readonly connection

Protected table

Methods

count

Parameters

distinct: boolean

tables: string

Optional columns: string[]

Optional where: string

Optional whereArgs: [] | DBValue[]

Optional join: string

Optional groupBy: string

Optional having: string

Optional orderBy: string

Optional limit: number

Optional offset: number

Returns number

countColumn

Returns

Parameters

table: string

distinct: boolean

column: string

where: string

args: any[]

Returns number

Protected Abstract createResult

Returns

Parameters

columns: string[]

resultSet: ResultSet

sql: string

selectionArgs: string[]

Returns TResult

getConnection

Returns GeoPackageConnection

getTable

Returns

Returns TTable

query

Parameters

distinct: boolean

tables: string

Optional columns: string[]

Optional where: string

Optional whereArgs: any[]

Optional join: string

Optional groupBy: string

Optional having: string

Optional orderBy: string

Optional limit: number

Optional offset: number

Returns TResult

querySQL

Inherit Doc

Parameters

distinct: boolean

tables: string

Class UserConnection<TColumn, TTable, TRow, TResult>`Abstract`

`Protected` constructor

`Protected` `Readonly` connection

`Protected` table

`Optional` columns: string[]

`Optional` where: string

`Optional` whereArgs: [] | DBValue[]

`Optional` join: string

`Optional` groupBy: string

`Optional` having: string

`Optional` orderBy: string

`Optional` limit: number

`Optional` offset: number

`Protected` `Abstract` createResult

`Optional` columns: string[]

`Optional` where: string

`Optional` whereArgs: any[]

`Optional` join: string

`Optional` groupBy: string

`Optional` having: string

`Optional` orderBy: string

`Optional` limit: number

`Optional` offset: number

`Optional` columns: string[]

`Optional` where: string

`Optional` join: string

`Optional` groupBy: string

`Optional` having: string

`Optional` orderBy: string

`Optional` limit: number

`Optional` offset: number