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

Abstract UserDao

Type Parameters

TColumn extends UserColumn
TTable extends UserTable<TColumn>
TRow extends UserRow<TColumn, TTable>
TResult extends UserResultSet<TColumn, TTable, TRow>

Hierarchy

UserDao

Index

Constructors

constructor

Properties

geoPackage projection

Methods

Constructors

`Protected` constructor

new UserDao<TColumn, TTable, TRow, TResult>(database: string, geoPackage: GeoPackage, userDb: UserConnection<TColumn, TTable, TRow, TResult>, table: TTable): UserDao<TColumn, TTable, TRow, TResult>
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
- database: string
- geoPackage: GeoPackage
- userDb: UserConnection<TColumn, TTable, TRow, TResult>
- table: TTable
Returns UserDao<TColumn, TTable, TRow, TResult>
- Defined in lib/user/userDao.ts:61

Properties

`Protected` `Readonly` geoPackage

geoPackage: GeoPackage

GeoPackage

`Protected` projection

projection: Projection

Projection

Methods

_buildWhereArgsWithArray

_buildWhereArgsWithArray(values: DBValue[]): DBValue[]
Builds a where args array

Returns
Parameters
- values: DBValue[]
  
  argument values to push
Returns DBValue[]
- Defined in lib/user/userDao.ts:1275

_buildWhereArgsWithColumnValues

_buildWhereArgsWithColumnValues(values: FieldValues): DBValue[]
Builds a where args array

Returns
Parameters
- values: FieldValues
  
  argument values to push
Returns DBValue[]
- Defined in lib/user/userDao.ts:1291

addColumn

addColumn(column: TColumn): void
Add a new column
Parameters
- column: TColumn
  
  new column
Returns void
- Defined in lib/user/userDao.ts:1607

alterColumn

alterColumn(column: TColumn): void
Alter a column
Parameters
- column: TColumn
  
  column
Returns void
- Defined in lib/user/userDao.ts:1709

alterColumns

alterColumns(columns: TColumn[]): void
Alter columns
Parameters
- columns: TColumn[]
  
  columns
Returns void
- Defined in lib/user/userDao.ts:1717

buildLimit

buildLimit(limit: number, offset: number): string
Build a limit String with the limit and offset

Returns
limit
Parameters
- limit: number
  
  limit
- offset: number
  
  offset
Returns string
- Defined in lib/user/userDao.ts:1574

buildWhere

buildWhere(field: string, value: any): string
Build where (or selection) statement for a single field

Returns
where clause
Parameters
- field: string
  
  field name
- value: any
  
  field value
Returns string
- Defined in lib/user/userDao.ts:1228

buildWhereArgs

buildWhereArgs(values: DBValue | DBValue[] | FieldValues): DBValue[]
Build where (or selection) args for the value

Returns
where args
Parameters
- values: DBValue | DBValue[] | FieldValues
  
  value
Returns DBValue[]
- Defined in lib/user/userDao.ts:1364

buildWhereArgsWithValues

buildWhereArgsWithValues(values: DBValue | DBValue[] | FieldValues): any[]
Builds a where args array

Returns
Parameters
- values: DBValue | DBValue[] | FieldValues
  
  argument values to push
Returns any[]
- Defined in lib/user/userDao.ts:1256

buildWhereIn

buildWhereIn(nestedSQL: string, where: string): string
Build where statement for ids in the nested SQL query

Returns
where clause
Parameters
- nestedSQL: string
  
  nested SQL
- where: string
  
  where clause
Returns string
- Defined in lib/user/userDao.ts:1318

buildWhereInArgs

buildWhereInArgs(nestedArgs: any[], whereArgs: any[]): any[]
Build where args for ids in the nested SQL query

Returns
where args
Parameters
- nestedArgs: any[]
  
  nested SQL args
- whereArgs: any[]
  
  where arguments
Returns any[]
- Defined in lib/user/userDao.ts:1335

buildWhereLike

buildWhereLike(field: string, value: any): string
Build where (or selection) LIKE statement for a single field

Returns
where clause
Parameters
- field: string
  
  field name
- value: any
  
  field value
Returns string
- Defined in lib/user/userDao.ts:1308

buildWhereWithFields

buildWhereWithFields(fields: FieldValues, operation??: string): string
Build where or selection statement for fields

Returns
where clause
Parameters
- fields: FieldValues
  
  columns and values
- Optional operation: string = 'and'
  
  AND or OR
Returns string
- Defined in lib/user/userDao.ts:1238

buildWhereWithOp

buildWhereWithOp(field: string, value: any, operation: string): string
Build where (or selection) statement for a single field using the provided operation

Returns
where clause
Parameters
- field: string
  
  field
- value: any
  
  value
- operation: string
  
  operation
Returns string
- Defined in lib/user/userDao.ts:1355

columnCount

columnCount(): number
Get the column count

Returns
column count

Returns number
- Defined in lib/user/userDao.ts:237

count

count(where?: string, whereArgs?: [] | DBValue[], join?: string, groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): number
Count
Parameters
- 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/userDao.ts:899

countColumn

countColumn(distinct: boolean, column: string, where: string, whereArgs: any[]): number
Get a count of results
Parameters
- distinct: boolean
- column: string
- where: string
- whereArgs: any[]
Returns number
- Defined in lib/user/userDao.ts:735

countColumnIn

countColumnIn(column: string, nestedSQL: string): number
Get the count in the nested SQL query

Returns
count
Parameters
- column: string
  
  count column name
- nestedSQL: string
  
  nested SQL
Returns number
- Defined in lib/user/userDao.ts:1043

countForEq

countForEq(fieldName: string, value: any, distinct?: boolean, columns?: string[], groupBy?: string, having?: string, orderBy?: string): number
Query for the row where the field equals the value
Parameters
- fieldName: string
- value: any
- distinct: boolean = false
- columns: string[] = ...
- Optional groupBy: string
- Optional having: string
- Optional orderBy: string
Returns number
- Defined in lib/user/userDao.ts:1433

countForFieldValues

countForFieldValues(fieldValues: FieldValues): number
Count where all fields match their values

Returns
count
Parameters
- fieldValues: FieldValues
  
  field values
Returns number
- Defined in lib/user/userDao.ts:1417

countIn

countIn(nestedSQL?: string, nestedArgs?: string[], where?: string, whereArgs?: string[]): number
Get the count in the nested SQL query

Returns
count
Parameters
- Optional nestedSQL: string
  
  nested SQL
- Optional nestedArgs: string[]
  
  nested SQL args
- Optional where: string
  
  where clause
- Optional whereArgs: string[]
  
  where arguments
Returns number
- Defined in lib/user/userDao.ts:1055

countInWithColumn

countInWithColumn(column?: string, nestedSQL?: string, nestedArgs?: string[], where?: string, whereArgs?: string[]): number
Get the count in the nested SQL query

Returns
count
Parameters
- Optional column: string
  
  count column name
- Optional nestedSQL: string
  
  nested SQL
- Optional nestedArgs: string[]
  
  nested SQL args
- Optional where: string
  
  where clause
- Optional whereArgs: string[]
  
  where arguments
Returns number
- Defined in lib/user/userDao.ts:1087

countInWithDistinct

countInWithDistinct(distinct?: boolean, nestedSQL?: string, nestedArgs?: string[], where?: string, whereArgs?: string[]): number
Get the count in the nested SQL query

Returns
count
Parameters
- Optional distinct: boolean
  
  distinct column values
- Optional nestedSQL: string
  
  nested SQL
- Optional nestedArgs: string[]
  
  nested SQL args
- Optional where: string
  
  where clause
- Optional whereArgs: string[]
  
  where arguments
Returns number
- Defined in lib/user/userDao.ts:1068

countInWithDistinctAndColumn

countInWithDistinctAndColumn(distinct?: boolean, column?: string, nestedSQL?: string, nestedArgs?: string[], where?: string, whereArgs?: string[]): number
Get the count in the nested SQL query

Returns
count
Parameters
- Optional distinct: boolean
  
  distinct column values
- Optional column: string
  
  count column name
- Optional nestedSQL: string
  
  nested SQL
- Optional nestedArgs: string[]
  
  nested SQL args
- Optional where: string
  
  where clause
- Optional whereArgs: string[]
  
  where arguments
Returns number
- Defined in lib/user/userDao.ts:1107

countWithColumns

countWithColumns(columns?: string[], where?: string, whereArgs?: [] | DBValue[], join?: string, groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): number
Count
Parameters
- 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/userDao.ts:972

countWithDistinct

countWithDistinct(distinct?: boolean, where?: string, whereArgs?: [] | DBValue[], join?: string, groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): number
Count
Parameters
- distinct: boolean = false
- 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/userDao.ts:935

countWithDistinctAndColumns

countWithDistinctAndColumns(distinct?: boolean, columns?: string[], where?: string, whereArgs?: any[] | DBValue[], join?: string, groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): number
Count
Parameters
- distinct: boolean = false
- columns: string[] = ...
- Optional where: string
- Optional whereArgs: any[] | 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/userDao.ts:1010

create

create(row: TRow): number
Parameters
- row: TRow
Returns number
- Defined in lib/user/userDao.ts:1837

delete

delete(whereClause?: string, whereArgs?: any[]): number
Delete rows matching the where clause

Returns
deleted count
Parameters
- Optional whereClause: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns number
- Defined in lib/user/userDao.ts:1734

deleteAll

deleteAll(): number
Delete all rows

Returns
deleted count

Returns number
- Defined in lib/user/userDao.ts:1742

deleteById

deleteById(id: number): number
Delete a row by id

Returns
number of rows affected, should be 0 or 1
Parameters
- id: number
  
  id
Returns number
- Defined in lib/user/userDao.ts:1753

deleteRow

deleteRow(row: TRow): number
Delete the row passed in
Parameters
- row: TRow
Returns number
- Defined in lib/user/userDao.ts:1724

deleteWithFieldValues

deleteWithFieldValues(fieldValues: FieldValues): number
Delete rows matching the field values

Returns
deleted count
Parameters
- fieldValues: FieldValues
  
  field values
Returns number
- Defined in lib/user/userDao.ts:1762

dropColumn

dropColumn(column: TColumn): void
Drop a column
Parameters
- column: TColumn
  
  column
Returns void
- Defined in lib/user/userDao.ts:1653

dropColumnIndexes

dropColumnIndexes(indexes: number[]): void
Drop columns
Parameters
- indexes: number[]
  
  column indexes
Returns void
- Defined in lib/user/userDao.ts:1689

dropColumnNames

dropColumnNames(columnNames: string[]): void
Drop columns
Parameters
- columnNames: string[]
  
  column names
Returns void
- Defined in lib/user/userDao.ts:1701

dropColumnWithIndex

dropColumnWithIndex(index: number): void
Drop a column
Parameters
- index: number
  
  column index
Returns void
- Defined in lib/user/userDao.ts:1661

dropColumnWithName

dropColumnWithName(columnName: string): void
Drop a column
Parameters
- columnName: string
  
  column name
Returns void
- Defined in lib/user/userDao.ts:1669

dropColumns

dropColumns(columns: TColumn[]): void
Drop columns
Parameters
- columns: TColumn[]
  
  columns
Returns void
- Defined in lib/user/userDao.ts:1677

dropTable

dropTable(): void
Drop the user table

Returns void
- Defined in lib/user/userDao.ts:299

`Protected` `Abstract` getBoundingBox

getBoundingBox(): BoundingBox
Get the bounding box of the user table data

Returns
bounding box of user table data

Returns BoundingBox
- Defined in lib/user/userDao.ts:86

`Protected` `Abstract` getBoundingBoxWithProjection

getBoundingBoxWithProjection(projection: Projection): BoundingBox
Get the bounding box of the user table data

Returns
bounding box of user table data
Parameters
- projection: Projection
  
  desired projection
Returns BoundingBox
- Defined in lib/user/userDao.ts:95

getColumnNames

getColumnNames(): string[]
Get the table column names

Returns
column names

Returns string[]
- Defined in lib/user/userDao.ts:228

getColumns

getColumns(): TColumn[]
Get the table columns

Returns
columns

Returns TColumn[]
- Defined in lib/user/userDao.ts:219

getContents

getContents(): Contents
Get the contents

Returns
contents

Returns Contents
- Defined in lib/user/userDao.ts:246

getCount

getCount(where?: string, whereArgs?: [] | DBValue[], join?: string, groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): number
Gets the count
Parameters
- 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/userDao.ts:750

getCountWithColumns

getCountWithColumns(columns?: string[], where?: string, whereArgs?: [] | DBValue[], join?: string, groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): number
Gets the count
Parameters
- 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/userDao.ts:823

getCountWithDistinct

getCountWithDistinct(distinct?: boolean, where?: string, whereArgs?: [] | DBValue[], join?: string, groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): number
Gets the count
Parameters
- distinct: boolean = false
- 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/userDao.ts:786

getCountWithDistinctAndColumns

getCountWithDistinctAndColumns(distinct?: boolean, columns?: string[], where?: string, whereArgs?: [] | DBValue[], join?: string, groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): number
Gets the count
Parameters
- distinct: boolean = false
- 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/userDao.ts:861

getDatabase

getDatabase(): string
Get the database

Returns
database

Returns string
- Defined in lib/user/userDao.ts:132

getDb

getDb(): GeoPackageConnection
Get the database connection

Returns
database connection

Returns GeoPackageConnection
- Defined in lib/user/userDao.ts:148

getGeoPackage

getGeoPackage(): GeoPackage
Get the GeoPackage

Returns GeoPackage
- Defined in lib/user/userDao.ts:139

getPkColumn

getPkColumn(): TColumn
Get the primary key column

Returns
primary key column

Returns TColumn
- Defined in lib/user/userDao.ts:202

getPkColumnIndex

getPkColumnIndex(): number
Get the primary key column index

Returns
primary key column index

Returns number
- Defined in lib/user/userDao.ts:193

getPkColumnName

getPkColumnName(): string
Get the primary key column name

Returns
primary key column name

Returns string
- Defined in lib/user/userDao.ts:211

`Protected` getPkWhere

getPkWhere(id: number): string
Get the primary key where clause

Returns
primary key where clause
Parameters
- id: number
  
  id
Returns string
- Defined in lib/user/userDao.ts:1209

`Protected` getPkWhereArgs

getPkWhereArgs(id: number): DBValue[]
Get the primary key where args

Returns
primary key where args
Parameters
- id: number
  
  id
Returns DBValue[]
- Defined in lib/user/userDao.ts:1218

getProjection

getProjection(): Projection
Get the projection

Returns
projection

Returns Projection
- Defined in lib/user/userDao.ts:255

getTable

getTable(): TTable
Get the table

Returns
table

Returns TTable
- Defined in lib/user/userDao.ts:175

getTableName

getTableName(): string
Get the table name

Returns
table name

Returns string
- Defined in lib/user/userDao.ts:166

getUserDb

getUserDb(): UserConnection<TColumn, TTable, TRow, TResult>
Get the user database connection

Returns
user database connection

Returns UserConnection<TColumn, TTable, TRow, TResult>
- Defined in lib/user/userDao.ts:157

getZoomLevelForBoundingBox

getZoomLevelForBoundingBox(): number
Get the approximate zoom level of where the bounding box of the user data fits into the world

Returns
zoom level

Returns number
- Defined in lib/user/userDao.ts:1384

hasPkColumn

hasPkColumn(): boolean
Check if the table has a primary key column

Returns
true if has a primary key

Returns boolean
- Defined in lib/user/userDao.ts:184

insert

insert(row: TRow): number
Inherit Doc
Parameters
- row: TRow
Returns number
- Defined in lib/user/userDao.ts:1844

insertOrThrow

insertOrThrow(values: ContentValues): number
Inserts a new row

Returns
row id
Parameters
- values: ContentValues
  
  content values
Returns number
- Defined in lib/user/userDao.ts:1870

insertWithContentValues

insertWithContentValues(values: ContentValues): number
Inserts a new row

Returns
row id, -1 on error
Parameters
- values: ContentValues
  
  content values
Returns number
- Defined in lib/user/userDao.ts:1859

isPkModifiable

isPkModifiable(): boolean
Is the primary key modifiable

Returns
true if the primary key is modifiable

Returns boolean
- Defined in lib/user/userDao.ts:264

isTableExists

isTableExists(): boolean
Checks if the table exists

Returns boolean
- Defined in lib/user/userDao.ts:2061

isValueValidation

isValueValidation(): boolean
Is value validation against column types enabled

Returns
true if values are validated against column types

Returns boolean
- Defined in lib/user/userDao.ts:282

max

max(column: string, where?: string, args?: any): number
Get the max result of the column

Returns
max or null
Parameters
- column: string
  
  column name
- Optional where: string
  
  where clause
- Optional args: any
  
  where arugments
Returns number
- Defined in lib/user/userDao.ts:1892

min

min(column: string, where?: string, args?: any): number
Get the min result of the column

Returns
min or null
Parameters
- column: string
  
  column name
- Optional where: string
  
  where clause
- Optional args: any
  
  where arugments
Returns number
- Defined in lib/user/userDao.ts:1881

`Abstract` newRow

newRow(): TRow
Get a new empty row

Returns
row

Returns TRow
- Defined in lib/user/userDao.ts:79

`Protected` prepareResult

prepareResult(result: TResult): TResult
Prepare the result before returning

Returns
prepared result
Parameters
- result: TResult
  
  result
Returns TResult
- Defined in lib/user/userDao.ts:123

projectBoundingBox

projectBoundingBox(boundingBox: BoundingBox, projection: Projection): BoundingBox
Project the provided bounding box in the declared projection to the user DAO projection

Returns
projected bounding box
Parameters
- boundingBox: BoundingBox
  
  bounding box
- projection: Projection
  
  projection
Returns BoundingBox
- Defined in lib/user/userDao.ts:107

query

query(where?: string, whereArgs?: any[], join?: string, groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): TResult
Query
Parameters
- 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/userDao.ts:588

queryForAll

queryForAll(): TResult
Query for all rows

Returns
result

Returns TResult
- Defined in lib/user/userDao.ts:328

queryForChunk

queryForChunk(where?: string, whereArgs?: any[], groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): TResult
Query for ordered rows starting at the offset and returning no more than the limit.
Parameters
- Optional where: string
- Optional whereArgs: any[]
- Optional groupBy: string
- Optional having: string
- Optional orderBy: string
- Optional limit: number
- Optional offset: number
Returns TResult
- Defined in lib/user/userDao.ts:1468

queryForChunkWithColumns

queryForChunkWithColumns(columns?: string[], where?: string, whereArgs?: any[], groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): TResult
Query for ordered rows starting at the offset and returning no more than the limit.
Parameters
- columns: string[] = ...
- Optional where: string
- Optional whereArgs: any[]
- Optional groupBy: string
- Optional having: string
- Optional orderBy: string
- Optional limit: number
- Optional offset: number
Returns TResult
- Defined in lib/user/userDao.ts:1517

queryForChunkWithDistinct

queryForChunkWithDistinct(distinct?: boolean, where?: string, whereArgs?: any[], groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): TResult
Query for ordered rows starting at the offset and returning no more than the limit.
Parameters
- distinct: boolean = false
- Optional where: string
- Optional whereArgs: any[]
- Optional groupBy: string
- Optional having: string
- Optional orderBy: string
- Optional limit: number
- Optional offset: number
Returns TResult
- Defined in lib/user/userDao.ts:1492

queryForChunkWithDistinctAndColumns

queryForChunkWithDistinctAndColumns(distinct?: boolean, columns?: string[], where?: string, whereArgs?: any[], groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): TResult
Query for ordered rows starting at the offset and returning no more than the limit.
Parameters
- distinct: boolean = false
- columns: string[] = ...
- Optional where: string
- Optional whereArgs: any[]
- Optional groupBy: string
- Optional having: string
- Optional orderBy: string
- Optional limit: number
- Optional offset: number
Returns TResult
- Defined in lib/user/userDao.ts:1543

queryForEq

queryForEq(property: string, value: any, groupBy?: string, having?: string, orderBy?: string): TResult
Query for the row where all fields match their values

Returns
result
Parameters
- property: string
  
  property name
- value: any
  
  property value
- Optional groupBy: string
- Optional having: string
- Optional orderBy: string
Returns TResult
- Defined in lib/user/userDao.ts:1976

queryForEqWithColumns

queryForEqWithColumns(columns?: string[], property: string, value: any, groupBy?: string, having?: string, orderBy?: string): TResult
Query for the row where all fields match their values

Returns
result
Parameters
- columns: string[] = ...
  
  columns
- property: string
  
  property name
- value: any
  
  property value
- Optional groupBy: string
- Optional having: string
- Optional orderBy: string
Returns TResult
- Defined in lib/user/userDao.ts:2011

queryForEqWithDistinct

queryForEqWithDistinct(distinct?: boolean, property: string, value: any, groupBy?: string, having?: string, orderBy?: string): TResult
Query for the row where all fields match their values

Returns
result
Parameters
- distinct: boolean = false
  
  distinct rows
- property: string
  
  property name
- value: any
  
  property value
- Optional groupBy: string
- Optional having: string
- Optional orderBy: string
Returns TResult
- Defined in lib/user/userDao.ts:1990

queryForEqWithDistinctAndColumns

queryForEqWithDistinctAndColumns(distinct?: boolean, columns?: string[], fieldName: string, value: any, groupBy?: string, having?: string, orderBy?: string): TResult
Query for the row where the field equals the value
Parameters
- distinct: boolean = false
- columns: string[] = ...
- fieldName: string
- value: any
- Optional groupBy: string
- Optional having: string
- Optional orderBy: string
Returns TResult
- Defined in lib/user/userDao.ts:2032

queryForEqWithFieldAndValue

queryForEqWithFieldAndValue(fieldName: string, value: any): TResult
Query for the row where the field equals the value

Returns
result
Parameters
- fieldName: string
  
  field name
- value: any
  
  value
Returns TResult
- Defined in lib/user/userDao.ts:1408

queryForFieldValues

queryForFieldValues(fieldValues: FieldValues): TResult
Query for the row where all fields match their values

Returns
result
Parameters
- fieldValues: FieldValues
  
  field values
Returns TResult
- Defined in lib/user/userDao.ts:1901

queryForFieldValuesWithColumns

queryForFieldValuesWithColumns(columns?: string[], fieldValues: FieldValues): TResult
Query for the row where all fields match their values

Returns
result
Parameters
- columns: string[] = ...
  
  columns
- fieldValues: FieldValues
  
  field values
Returns TResult
- Defined in lib/user/userDao.ts:1921

queryForFieldValuesWithDistinct

queryForFieldValuesWithDistinct(distinct?: boolean, fieldValues: FieldValues): TResult
Query for the row where all fields match their values

Returns
result
Parameters
- distinct: boolean = false
  
  distinct rows
- fieldValues: FieldValues
  
  field values
Returns TResult
- Defined in lib/user/userDao.ts:1911

queryForFieldValuesWithDistinctAndColumns

queryForFieldValuesWithDistinctAndColumns(distinct?: boolean, columns?: string[], fieldValues: FieldValues): TResult
Query for the row where all fields match their values

Returns
result
Parameters
- distinct: boolean = false
  
  distinct rows
- columns: string[] = ...
  
  columns
- fieldValues: FieldValues
  
  field values
Returns TResult
- Defined in lib/user/userDao.ts:1935

queryForId

queryForId(id: number): TResult
Query for the row with the provided id

Returns
row
Parameters
- id: number
  
  id
Returns TResult
- Defined in lib/user/userDao.ts:1156

queryForIdRow

queryForIdRow(id: number): TRow
Query for the row with the provided id

Returns
row
Parameters
- id: number
  
  id
Returns TRow
- Defined in lib/user/userDao.ts:1141

queryForIdRows

queryForIdRows(ids: number[]): TRow[]
Gets the rows in this table by id

Returns
rows array
Parameters
- ids: number[]
  
  ids to query for
Returns TRow[]
- Defined in lib/user/userDao.ts:1125

queryForLike

queryForLike(field: string, value: any): TResult
Query for the rows that are like the column

Returns
result
Parameters
- field: string
- value: any
Returns TResult
- Defined in lib/user/userDao.ts:1953

queryIdsSQL

queryIdsSQL(distinct?: boolean, where?: string): string
Query SQL for all row ids

Returns
SQL
Parameters
- distinct: boolean = false
  
  distinct rows
- Optional where: string
  
  where
Returns string
- Defined in lib/user/userDao.ts:1188

queryIn

queryIn(nestedSQL?: string, nestedArgs?: any[], where?: string, whereArgs?: any[]): TResult
Query for rows by ids in the nested SQL query

Returns
result
Parameters
- Optional nestedSQL: string
  
  nested SQL
- Optional nestedArgs: any[]
  
  nested SQL args
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns TResult
- Defined in lib/user/userDao.ts:341

queryInForChunk

queryInForChunk(nestedSQL?: string, nestedArgs?: any[], where?: string, whereArgs?: any[], groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): TResult
Query for ordered rows by ids in the nested SQL query, starting at the offset and returning no more than the limit.

Returns
result
Parameters
- Optional nestedSQL: string
  
  nested SQL
- Optional nestedArgs: any[]
  
  nested SQL args
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
- Optional groupBy: string
  
  group by
- Optional having: string
  
  having
- Optional orderBy: string
  
  order by
- Optional limit: number
  
  chunk limit
- Optional offset: number
  
  chunk offset
Returns TResult
- Defined in lib/user/userDao.ts:423

queryInForChunkWithColumns

queryInForChunkWithColumns(columns: string[], nestedSQL?: string, nestedArgs?: any[], where?: string, whereArgs?: any[], groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): TResult
Query for ordered rows by ids in the nested SQL query, starting at the offset and returning no more than the limit.

Returns
result
Parameters
- columns: string[]
  
  columns
- Optional nestedSQL: string
  
  nested SQL
- Optional nestedArgs: any[]
  
  nested SQL args
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
- Optional groupBy: string
  
  group by
- Optional having: string
  
  having
- Optional orderBy: string
  
  order by
- Optional limit: number
  
  chunk limit
- Optional offset: number
  
  chunk offset
Returns TResult
- Defined in lib/user/userDao.ts:506

queryInForChunkWithDistinct

queryInForChunkWithDistinct(distinct: boolean, nestedSQL?: string, nestedArgs?: any[], where?: string, whereArgs?: any[], groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): TResult
Query for ordered rows by ids in the nested SQL query, starting at the offset and returning no more than the limit.

Returns
result
Parameters
- distinct: boolean
  
  distinct rows
- Optional nestedSQL: string
  
  nested SQL
- Optional nestedArgs: any[]
  
  nested SQL args
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
- Optional groupBy: string
  
  group by
- Optional having: string
  
  having
- Optional orderBy: string
  
  order by
- Optional limit: number
  
  chunk limit
- Optional offset: number
  
  chunk offset
Returns TResult
- Defined in lib/user/userDao.ts:464

queryInForChunkWithDistinctAndColumns

queryInForChunkWithDistinctAndColumns(distinct: boolean, columns: string[], nestedSQL?: string, nestedArgs?: any[], where?: string, whereArgs?: any[], groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): TResult
Query for ordered rows by ids in the nested SQL query, starting at the offset and returning no more than the limit.

Returns
result
Parameters
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
- Optional nestedSQL: string
  
  nested SQL
- Optional nestedArgs: any[]
  
  nested SQL args
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
- Optional groupBy: string
  
  group by
- Optional having: string
  
  having
- Optional orderBy: string
  
  order by
- Optional limit: number
  
  chunk limit
- Optional offset: number
  
  chunk offset
Returns TResult
- Defined in lib/user/userDao.ts:549

queryInWithColumns

queryInWithColumns(columns: string[], nestedSQL?: string, nestedArgs?: any[], where?: string, whereArgs?: any[]): TResult
Query for rows by ids in the nested SQL query

Returns
result
Parameters
- columns: string[]
  
  columns
- Optional nestedSQL: string
  
  nested SQL
- Optional nestedArgs: any[]
  
  nested SQL args
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns TResult
- Defined in lib/user/userDao.ts:375

queryInWithDistinct

queryInWithDistinct(distinct: boolean, nestedSQL?: string, nestedArgs?: any[], where?: string, whereArgs?: any[]): TResult
Query for rows by ids in the nested SQL query

Returns
result
Parameters
- distinct: boolean
  
  distinct rows
- Optional nestedSQL: string
  
  nested SQL
- Optional nestedArgs: any[]
  
  nested SQL args
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns TResult
- Defined in lib/user/userDao.ts:355

queryInWithDistinctAndColumns

queryInWithDistinctAndColumns(distinct?: boolean, columns?: string[], nestedSQL?: string, nestedArgs?: any[], where?: string, whereArgs?: any[]): TResult
Query for rows by ids in the nested SQL query

Returns
result
Parameters
- Optional distinct: boolean
  
  distinct rows
- Optional columns: string[]
  
  columns
- Optional nestedSQL: string
  
  nested SQL
- Optional nestedArgs: any[]
  
  nested SQL args
- Optional where: string
  
  where clause
- Optional whereArgs: any[]
  
  where arguments
Returns TResult
- Defined in lib/user/userDao.ts:396

querySQL

querySQL(distinct: boolean, columns: string[], where?: string): string
Query SQL for all rows

Returns
SQL
Parameters
- distinct: boolean
  
  distinct rows
- columns: string[]
  
  columns
- Optional where: string
  
  where
Returns string
- Defined in lib/user/userDao.ts:1200

querySingleColumnTypedResults

querySingleColumnTypedResults(sql: string, args: string[], columnName: string, limit?: number): any[]
Query for typed values from the first column

Returns
single column values
Parameters
- sql: string
  
  sql statement
- args: string[]
  
  sql arguments
- columnName: string
- Optional limit: number
Returns any[]
- Defined in lib/user/userDao.ts:1776

querySingleColumnTypedResultsWithColumnIndex

querySingleColumnTypedResultsWithColumnIndex(sql: string, args: string[], columnIndex?: number, limit?: number): any[]
Query for typed values from the first column

Returns
single column values
Parameters
- sql: string
  
  sql statement
- args: string[]
  
  sql arguments
- columnIndex: number = 0
- Optional limit: number
Returns any[]
- Defined in lib/user/userDao.ts:1791

querySingleResult

querySingleResult(sql: string, args: string[]): any
Query the SQL for a single result object in the first column

Returns
single result object
Parameters
- sql: string
  
  sql statement
- args: string[]
  
  sql arguments
Returns any
- Defined in lib/user/userDao.ts:1170

queryWithColumns

queryWithColumns(columns: string[], where?: string, whereArgs?: any[], join?: string, groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): TResult
Query
Parameters
- 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/userDao.ts:661

queryWithDistinct

queryWithDistinct(distinct: boolean, where?: string, whereArgs?: any[], join?: string, groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): TResult
Query
Parameters
- distinct: boolean
- 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/userDao.ts:624

queryWithDistinctAndColumns

queryWithDistinctAndColumns(distinct?: boolean, columns?: string[], where?: string, whereArgs?: any[], join?: string, groupBy?: string, having?: string, orderBy?: string, limit?: number, offset?: number): TResult
Query
Parameters
- distinct: boolean = false
- 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/userDao.ts:699

rawQueryWithArgs

rawQueryWithArgs(sql: string, selectionArgs?: []): TResult
Raw query

Returns
result
Parameters
- sql: string
  
  SQL
- Optional selectionArgs: []
  
  selection args
Returns TResult
- Defined in lib/user/userDao.ts:309

rawQueryWithColumns

rawQueryWithColumns(sql: string, columns: string[], selectionArgs: any[]): TResult
Raw query

Returns
result
Parameters
- sql: string
  
  SQL
- columns: string[]
  
  subset of table columns defined in the SQL
- selectionArgs: any[]
  
  selection args
Returns TResult
- Defined in lib/user/userDao.ts:320

renameColumn

renameColumn(column: TColumn, newColumnName: string): void
Rename column
Parameters
- column: TColumn
  
  column
- newColumnName: string
  
  new column name
Returns void
- Defined in lib/user/userDao.ts:1617

renameColumnWithIndex

renameColumnWithIndex(index: number, newColumnName: string): void
Rename column
Parameters
- index: number
  
  column index
- newColumnName: string
  
  new column name
Returns void
- Defined in lib/user/userDao.ts:1635

renameColumnWithName

renameColumnWithName(columnName: string, newColumnName: string): void
Rename column
Parameters
- columnName: string
  
  column name
- newColumnName: string
  
  new column name
Returns void
- Defined in lib/user/userDao.ts:1626

`Protected` renameTableColumn

renameTableColumn(columnName: string, newColumnName: string): void
Rename a table column
Parameters
- columnName: string
  
  column name
- newColumnName: string
  
  new column name
Returns void
- Defined in lib/user/userDao.ts:1644

setPkModifiable

setPkModifiable(pkModifiable: boolean): void
Set if the primary key can be modified
Parameters
- pkModifiable: boolean
  
  primary key modifiable flag
Returns void
- Defined in lib/user/userDao.ts:273

setValueValidation

setValueValidation(valueValidation: boolean): void
Set if values should validated against column types
Parameters
- valueValidation: boolean
  
  value validation flag
Returns void
- Defined in lib/user/userDao.ts:292

update

update(row: TRow): number
Updates a row
Parameters
- row: TRow
Returns number
- Defined in lib/user/userDao.ts:1810

updateWithContentValues

updateWithContentValues(values: ContentValues, whereClause?: string, whereArgs?: []): number
Update all rows matching the where clause with the provided values

Returns
updated count
Parameters
- values: ContentValues
  
  content values
- Optional whereClause: string
  
  where clause
- Optional whereArgs: []
  
  where arguments
Returns number
- Defined in lib/user/userDao.ts:1833

Class UserDao<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

database: string

geoPackage: GeoPackage

userDb: UserConnection<TColumn, TTable, TRow, TResult>

table: TTable

Returns UserDao<TColumn, TTable, TRow, TResult>

Properties

Protected Readonly geoPackage

Protected projection

Methods

_buildWhereArgsWithArray

Returns

Parameters

values: DBValue[]

Returns DBValue[]

_buildWhereArgsWithColumnValues

Returns

Parameters

values: FieldValues

Returns DBValue[]

addColumn

Parameters

column: TColumn

Returns void

alterColumn

Parameters

column: TColumn

Returns void

alterColumns

Parameters

columns: TColumn[]

Returns void

buildLimit

Returns

Parameters

limit: number

offset: number

Returns string

buildWhere

Returns

Parameters

field: string

value: any

Returns string

buildWhereArgs

Returns

Parameters

values: DBValue | DBValue[] | FieldValues

Returns DBValue[]

buildWhereArgsWithValues

Returns

Parameters

values: DBValue | DBValue[] | FieldValues

Returns any[]

buildWhereIn

Returns

Parameters

nestedSQL: string

where: string

Returns string

buildWhereInArgs

Returns

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

`Protected` constructor

`Protected` `Readonly` geoPackage

`Protected` projection

`Optional` operation: string = 'and'

`Optional` where: string

`Optional` whereArgs: [] | DBValue[]

`Optional` join: string

`Optional` groupBy: string

`Optional` having: string

`Optional` orderBy: string

`Optional` limit: number

`Optional` offset: number

`Optional` groupBy: string

`Optional` having: string

`Optional` orderBy: string

`Optional` nestedSQL: string

`Optional` nestedArgs: string[]