Class Dao<T, ID>`Abstract`

Base DAO

Type Parameters

Hierarchy

Dao
- GeoPackageDao

Index

Constructors

constructor

Properties

db geoPackage gpkgTableName idColumns

Constructors

constructor

new Dao<T, ID>(geoPackage: GeoPackage, tableName?: string): Dao<T, ID>
Constructor
Type Parameters
- T
- ID
Parameters
- geoPackage: GeoPackage
  
  GeoPackageConnection object
- Optional tableName: string
  
  tableName
Returns Dao<T, ID>
- Defined in lib/dao/dao.ts:63

Properties

`Readonly` db

db: GeoPackageConnection

Database connection to the sqlite file

`Readonly` geoPackage

geoPackage: GeoPackage

GeoPackage

gpkgTableName

gpkgTableName: string

Name of the table within the GeoPackage

idColumns

idColumns: string[]

ID Columns for this DAO

Methods

_buildWhereArgsWithArray

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

Returns
Parameters
- values: DBValue[]
  
  argument values to push
Returns DBValue[]
- Defined in lib/dao/dao.ts:527

_buildWhereArgsWithColumnValues

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

Returns
Parameters
- values: FieldValues
  
  argument values to push
Returns DBValue[]
- Defined in lib/dao/dao.ts:543

buildPkWhere

buildPkWhere(idValue: any): string
Get the primary key where clause

Returns
primary key where clause
Parameters
- idValue: any
  
  id
Returns string
- Defined in lib/dao/dao.ts:433

buildPkWhereArgs

buildPkWhereArgs(idValue: DBValue | DBValue[]): DBValue[]
Get the primary key where args

Returns
where args
Parameters
- idValue: DBValue | DBValue[]
  
  id
Returns DBValue[]
- Defined in lib/dao/dao.ts:450

buildWhere

buildWhere(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/dao/dao.ts:490

buildWhereArgs

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

Returns
Parameters
- values: DBValue | DBValue[] | FieldValues
  
  argument values to push
Returns DBValue[]
- Defined in lib/dao/dao.ts:508

buildWhereLike

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

Returns
where clause
Parameters
- fields: FieldValues
  
  columns and values
- Optional operation: string
  
  AND or OR
Returns string
- Defined in lib/dao/dao.ts:471

buildWhereWithFieldAndValue

buildWhereWithFieldAndValue(field: string, value?: DBValue, operation??: string): string
Builds a where clause from the field and value with an optional operation. If the value is empty, 'is null' is added to the query for the field

Returns
where clause
Parameters
- field: string
  
  field name
- Optional value: DBValue
  
  optional value to filter on
- Optional operation: string = '='
  
  optional operation
Returns string
- Defined in lib/dao/dao.ts:561

count

count(fields?: string | FieldValues, value?: DBValue): number
Count rows in the table optionally filtered by the parameters specified

Returns
count of objects
Parameters
- Optional fields: string | FieldValues
  
  Either a ColumnValues object or a string specifying a field name
- Optional value: DBValue
  
  value to filter on if fields is a string
Returns number
- Defined in lib/dao/dao.ts:608

countJoinWhereWithArgs

countJoinWhereWithArgs(join: string, where?: string, whereArgs?: DBValue[]): number
Count all matching objects

Returns
Parameters
- join: string
  
  join clause
- Optional where: string
  
  where clause
- Optional whereArgs: DBValue[]
  
  array of where query values
Returns number
- Defined in lib/dao/dao.ts:354

countWhere

countWhere(where: string, whereArgs: DBValue[]): number
Count rows in the table optionally filtered by the parameters specified

Returns
count of objects
Parameters
- where: string
  
  where string
- whereArgs: DBValue[]
  
  arguments to filter on
Returns number
- Defined in lib/dao/dao.ts:634

create

create(object: T): number
Insert the object into the table

Returns
id of the inserted object
Parameters
- object: T
  
  object to be inserted
Returns number
- Defined in lib/dao/dao.ts:727

`Abstract` createObject

createObject(result: Record<string, DBValue>): T
Creates a object from the result
Parameters
- result: Record<string, DBValue>
Returns T
- Defined in lib/dao/dao.ts:72

createOrUpdate

createOrUpdate(object: T): CreateOrUpdateStatus
Queries for the object by id, and if it exists, updates it, otherwise creates a new object

Returns
number of objects modified
Parameters
- object: T
  
  object to update or create
Returns CreateOrUpdateStatus
- Defined in lib/dao/dao.ts:783

delete

delete(object: Record<string, DBValue> | T): number
Delete the object passed in. Object is deleted by id

Returns
number of objects deleted
Parameters
- object: Record<string, DBValue> | T
  
  object to delete
Returns number
- Defined in lib/dao/dao.ts:667

deleteAll

deleteAll(): number
Delete all objects in the table

Returns
number of objects deleted

Returns number
- Defined in lib/dao/dao.ts:718

deleteByID

deleteByID(id: ID): void
Parameters
- id: ID
Returns void
- Defined in lib/dao/dao.ts:696

deleteById

deleteById(idValue: DBValue): number
Delete the object specified by the id

Returns
number of objects deleted
Parameters
- idValue: DBValue
  
  id value
Returns number
- Defined in lib/dao/dao.ts:679

deleteByMultiId

deleteByMultiId(idValues: any[]): number
Delete the object specified by the ids

Returns
number of objects deleted
Parameters
- idValues: any[]
  
  id values
Returns number
- Defined in lib/dao/dao.ts:690

deleteWhere

deleteWhere(where: string, whereArgs: DBValue[]): number
Delete objects that match the query

Returns
number of objects deleted
Parameters
- where: string
  
  where clause
- whereArgs: DBValue[]
  
  where arguments
Returns number
- Defined in lib/dao/dao.ts:710

dropTable

dropTable(): void
Drop the user table

Returns void
- Defined in lib/dao/dao.ts:797

dropTableWithTableName

dropTableWithTableName(tableName: string): void
Drops this table
Parameters
- tableName: string
Returns void
- Defined in lib/dao/dao.ts:804

getMultiId

getMultiId(object: any): any[]
Parameters
- object: any
Returns any[]
- Defined in lib/dao/dao.ts:129

getTableName

getTableName(): string
Returns string
- Defined in lib/dao/dao.ts:74

idExists

idExists(id: ID): boolean
Checks if the ID exists
Parameters
- id: ID
Returns boolean
- Defined in lib/dao/dao.ts:89

isTableExists

isTableExists(): boolean
Checks if the table exists

Returns boolean
- Defined in lib/dao/dao.ts:81

maxOfColumn

maxOfColumn(column: string, where?: string, whereArgs?: DBValue[]): number
Get the max of the column

Returns
Parameters
- column: string
  
  column name
- Optional where: string
  
  where clause
- Optional whereArgs: DBValue[]
  
  where args
Returns number
- Defined in lib/dao/dao.ts:658

minOfColumn

minOfColumn(column: string, where?: string, whereArgs?: DBValue[]): number
Get the min of the column

Returns
Parameters
- column: string
  
  column name
- Optional where: string
  
  where clause
- Optional whereArgs: DBValue[]
  
  where args
Returns number
- Defined in lib/dao/dao.ts:647

queryAllRaw

queryAllRaw(sql: string, params?: [] | Record<string, any>): Record<string, DBValue>[]
Performs a raw query
Parameters
- sql: string
- Optional params: [] | Record<string, any>
Returns Record<string, DBValue>[]
- Defined in lib/dao/dao.ts:168

queryEachRaw

queryEachRaw(sql: string, params?: [] | Record<string, any>): IterableIterator<any>
Performs a raw query
Parameters
- sql: string
- Optional params: [] | Record<string, any>
Returns IterableIterator<any>
- Defined in lib/dao/dao.ts:177

queryForAll

queryForAll(where?: string, whereArgs?: DBValue[]): Record<string, DBValue>[]
Queries for all matches and returns them in the callback. Be aware this pulls all results into memory

Returns
raw object array from the database
Parameters
- Optional where: string
  
  Optional where clause
- Optional whereArgs: DBValue[]
  
  Optional where args array
Returns Record<string, DBValue>[]
- Defined in lib/dao/dao.ts:187

queryForAllAndCreateObjects

queryForAllAndCreateObjects(where?: string, whereArgs?: DBValue[]): T[]
Queries for all matches and returns them in the callback. Be aware this pulls all results into memory

Returns
raw object array from the database
Parameters
- Optional where: string
  
  Optional where clause
- Optional whereArgs: DBValue[]
  
  Optional where args array
Returns T[]
- Defined in lib/dao/dao.ts:198

queryForAllEq

queryForAllEq(field: string, value: DBValue, groupBy?: string, having?: string, orderBy?: string): Record<string, DBValue>[]
Query for all rows in the table that match

Returns
array of raw database objects
Parameters
- field: string
  
  field to match
- value: DBValue
  
  value to match
- Optional groupBy: string
  
  group by clause
- Optional having: string
  
  having clause
- Optional orderBy: string
  
  order by clause
Returns Record<string, DBValue>[]
- Defined in lib/dao/dao.ts:580

queryForChunk

queryForChunk(pageSize: number, page: number): Record<string, DBValue>[]
Queries for all items in the table with a page size and page number

Returns
raw object array from the database
Parameters
- pageSize: number
  
  size of the chunk to query for
- page: number
  
  chunk number to query for
Returns Record<string, DBValue>[]
- Defined in lib/dao/dao.ts:252

queryForColumnWhere

queryForColumnWhere(columnName: string, where?: string, whereArgs?: DBValue[]): Record<string, DBValue>[]
Query for column of rows matching the where clause
Parameters
- columnName: string
- Optional where: string
- Optional whereArgs: DBValue[]
Returns Record<string, DBValue>[]
- Defined in lib/dao/dao.ts:241

queryForColumns

queryForColumns(columnName: string, fieldValues?: FieldValues): Record<string, DBValue>[]
Queries for all matches and returns them. Only queries for the specified column name Be aware this pulls all results into memory

Returns
raw object array from the database
Parameters
- columnName: string
  
  name of the column to query for
- Optional fieldValues: FieldValues
  
  optional values to filter on
Returns Record<string, DBValue>[]
- Defined in lib/dao/dao.ts:224

queryForEach

queryForEach(field?: string, value?: DBValue, groupBy?: string, having?: string, orderBy?: string, columns?: string[]): IterableIterator<Record<string, DBValue>>
Iterate all items in the table one at a time. If no parameters are passed, iterates the entire table. Returns an Iterable object

Returns
iterable of database objects
Parameters
- Optional field: string
  
  field to filter on
- Optional value: DBValue
  
  value to filter on
- Optional groupBy: string
  
  group by clause
- Optional having: string
  
  having clause
- Optional orderBy: string
  
  order by clause
- Optional columns: string[]
  
  columns to retrieve
Returns IterableIterator<Record<string, DBValue>>
- Defined in lib/dao/dao.ts:278

queryForEq

queryForEq(field: string, value: any): T[]
Query for equal
Parameters
- field: string
- value: any
Returns T[]
- Defined in lib/dao/dao.ts:120

queryForFieldValues

queryForFieldValues(fieldValues: FieldValues): IterableIterator<Record<string, DBValue>>
Iterate all objects in thet able that match the ColumnValues passed in

Returns
Parameters
- fieldValues: FieldValues
  
  ColumnValues to query for
Returns IterableIterator<Record<string, DBValue>>
- Defined in lib/dao/dao.ts:322

queryForId

queryForId(id: DBValue): T
Query for object by id

Returns
object created from the raw database object
Parameters
- id: DBValue
  
  ID of the object to query for
Returns T
- Defined in lib/dao/dao.ts:106

`Abstract` queryForIdWithKey

queryForIdWithKey(key: ID): T
Parameters
- key: ID
Returns T
- Defined in lib/dao/dao.ts:315

queryForLike

queryForLike(fieldName: string, value: string): Record<string, DBValue>[]
Queries for all matches and returns them in the callback. Be aware this pulls all results into memory

Returns
raw object array from the database
Parameters
- fieldName: string
  
  name of the field to query for
- value: string
  
  value of the like clause
Returns Record<string, DBValue>[]
- Defined in lib/dao/dao.ts:209

queryForMultiId

queryForMultiId(idValues: DBValue[]): T
Query for object by multi id

Returns
object created from the raw database object
Parameters
- idValues: DBValue[]
  
  ColumnValues with the multi id
Returns T
- Defined in lib/dao/dao.ts:145

queryForSameId

queryForSameId(object: T): T
Parameters
- object: T
Returns T
- Defined in lib/dao/dao.ts:124

queryJoinWhereWithArgs

queryJoinWhereWithArgs(join: string, where?: string, whereArgs?: DBValue[], columns?: string[]): IterableIterator<Record<string, DBValue>>
Iterate all matching objects

Returns
Parameters
- join: string
  
  join clause
- Optional where: string
  
  where clause
- Optional whereArgs: DBValue[]
  
  array of where query values
- Optional columns: string[]
  
  columns to query for
Returns IterableIterator<Record<string, DBValue>>
- Defined in lib/dao/dao.ts:337

queryRaw

queryRaw(sql: string, params?: [] | Record<string, any>): Record<string, DBValue>
Performs a raw query
Parameters
- sql: string
- Optional params: [] | Record<string, any>
Returns Record<string, DBValue>
- Defined in lib/dao/dao.ts:159

queryWhere

queryWhere(where?: string, whereArgs?: DBValue[], groupBy?: string, having?: string, orderBy?: string, limit?: number): IterableIterator<Record<string, DBValue>>
Iterate all matching rows

Returns
Parameters
- Optional where: string
  
  where clause
- Optional whereArgs: DBValue[]
  
  array of where query values
- Optional groupBy: string
  
  group by clause
- Optional having: string
  
  having clause
- Optional orderBy: string
  
  order by clause
- Optional limit: number
  
  limit clause
Returns IterableIterator<Record<string, DBValue>>
- Defined in lib/dao/dao.ts:406

queryWhereWithArgsDistinct

queryWhereWithArgsDistinct(where: string, whereArgs?: DBValue[]): IterableIterator<Record<string, DBValue>>
Iterate all distinct matching rows in the table

Returns
Parameters
- where: string
  
  where clause
- Optional whereArgs: DBValue[]
  
  array of where query values
Returns IterableIterator<Record<string, DBValue>>
- Defined in lib/dao/dao.ts:366

refresh

refresh(object: T): T
Refreshes the object by id
Parameters
- object: T
  
  object to refresh
Returns T
- Defined in lib/dao/dao.ts:97

rename

rename(newName: string): void
Rename the table
Parameters
- newName: string
Returns void
- Defined in lib/dao/dao.ts:812

update

update(object: T): {
changes: number;
lastInsertRowid: number;
}
Update the object specified

Returns
number of objects updated
Parameters
- object: T
  
  object with updated values
Returns {
changes: number;
lastInsertRowid: number;
}
- changes: number
- lastInsertRowid: number
- Defined in lib/dao/dao.ts:757

updateWithValues

updateWithValues(values: Record<string, DBValue>, where: string, whereArgs: DBValue[]): {
changes: number;
lastInsertRowid: number;
}
Update all rows that match the query

Returns
number of objects updated
Parameters
- values: Record<string, DBValue>
  
  values to insert
- where: string
  
  where clause
- whereArgs: DBValue[]
  
  where arguments
Returns {
changes: number;
lastInsertRowid: number;
}
- changes: number
- lastInsertRowid: number
- Defined in lib/dao/dao.ts:740

Class Dao<T, ID>Abstract

Type Parameters

T

ID

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T

ID

Parameters

geoPackage: GeoPackage

Optional tableName: string

Returns Dao<T, ID>

Properties

Readonly db

Readonly geoPackage

gpkgTableName

idColumns

Methods

_buildWhereArgsWithArray

Returns

Parameters

values: DBValue[]

Returns DBValue[]

_buildWhereArgsWithColumnValues

Returns

Parameters

values: FieldValues

Returns DBValue[]

buildPkWhere

Returns

Parameters

idValue: any

Returns string

buildPkWhereArgs

Returns

Parameters

idValue: DBValue | DBValue[]

Returns DBValue[]

buildWhere

Returns

Parameters

fields: FieldValues

Optional operation: string = 'and'

Returns string

buildWhereArgs

Returns

Parameters

values: DBValue | DBValue[] | FieldValues

Returns DBValue[]

buildWhereLike

Returns

Parameters

fields: FieldValues

Optional operation: string

Returns string

buildWhereWithFieldAndValue

Returns

Parameters

field: string

Optional value: DBValue

Optional operation: string = '='

Returns string

count

Returns

Parameters

Optional fields: string | FieldValues

Optional value: DBValue

Returns number

countJoinWhereWithArgs

Returns

Parameters

join: string

Optional where: string

Optional whereArgs: DBValue[]

Class Dao<T, ID>`Abstract`

`Optional` tableName: string

`Readonly` db

`Readonly` geoPackage

`Optional` operation: string = 'and'

`Optional` operation: string

`Optional` value: DBValue

`Optional` operation: string = '='

`Optional` fields: string | FieldValues

`Optional` value: DBValue

`Optional` where: string

`Optional` whereArgs: DBValue[]

`Abstract` createObject