Class DataAccessObject

Data Access object.

Hierarchy

DataAccessObject

Index

Constructors

constructor

new DataAccessObject(source: string, table: string, pk: string, row: any): DataAccessObject
DAO constructor.
Parameters
- source: string
  
  Data source
- table: string
  
  Table name
- pk: string
  
  Private key name
- row: any
Returns DataAccessObject
- Defined in dao.ts:185

Properties

original

original: any

pk

pk: string

ref

ref: any

source

source: string

table

table: string

Methods

changeRef

changeRef(row: any): void
Parameters
- row: any
Returns void
- Defined in dao.ts:193

delete

delete(): Promise<boolean>
Deletes the document.

Returns
True if deleted, false if not deleted

Returns Promise<boolean>
- Defined in dao.ts:247

increment

increment(field: string, inc: number): Promise<void>
Atomic increment
Parameters
- field: string
  
  Name of the field
- inc: number
  
  Amount to increment
Returns Promise<void>
- Defined in dao.ts:259

insert

insert(): Promise<void>
Inserts the document.

Returns Promise<void>
- Defined in dao.ts:201

save

save(condition?: DataFilter<any>): Promise<boolean>
Saves the document changes.

Returns
True if saved, false if not saved
Parameters
- Optional condition: DataFilter<any>
  
  Optional. Condition to check before updating.
Returns Promise<boolean>
- Defined in dao.ts:218

`Static` count

count(source: string, table: string, filter: GenericFilter, queryExtraOptions: QueryExtraOptions): Promise<number>
Counts instances
Parameters
- source: string
  
  Data source name
- table: string
  
  Table name
- filter: GenericFilter
  
  Filter to apply
- queryExtraOptions: QueryExtraOptions
  
  Additional query options
Returns Promise<number>
- Defined in dao.ts:101

`Static` deleteMany

deleteMany(source: string, table: string, filter: GenericFilter): Promise<number>
Deletes rows
Parameters
- source: string
  
  Data source name
- table: string
  
  Table name
- filter: GenericFilter
  
  Filter to apply
Returns Promise<number>
- Defined in dao.ts:143

`Static` find

find(source: string, table: string, filter: GenericFilter, sortBy: string, sortDir: SortDirection, skip: number, limit: number, projection: Set<string>, queryExtraOptions: QueryExtraOptions): Promise<any[]>
Finds rows
Parameters
- source: string
  
  Data source name
- table: string
  
  Table name
- filter: GenericFilter
  
  Filter to apply
- sortBy: string
  
  Sort results by this field. Leave as null for default sorting
- sortDir: SortDirection
  
  "asc" or "desc". Leave as null for default sorting
- skip: number
  
  Number of rows to skip. Leave as -1 for no skip
- limit: number
  
  Limit of results. Leave as -1 for no limit
- projection: Set<string>
  
  List of fields to fetch from the table. Leave as null to fetch them all.
- queryExtraOptions: QueryExtraOptions
  
  Additional query options
Returns Promise<any[]>
- Defined in dao.ts:56

`Static` findByKey

findByKey(source: string, table: string, keyName: string, keyValue: any): Promise<any>
Finds by primary key
Parameters
- source: string
  
  Data source name
- table: string
  
  Table name
- keyName: string
  
  Key name
- keyValue: any
  
  Key value
Returns Promise<any>
- Defined in dao.ts:37

`Static` findStream

findStream(source: string, table: string, filter: GenericFilter, sortBy: string, sortDir: SortDirection, skip: number, limit: number, projection: Set<string>, queryExtraOptions: QueryExtraOptions, each: ((row: any) => Promise<void>)): Promise<void>
Finds rows (stream) / Async
Parameters
- source: string
  
  Data source name
- table: string
  
  Table name
- filter: GenericFilter
  
  Filter to apply
- sortBy: string
  
  Sort results by this field. Leave as null for default sorting
- sortDir: SortDirection
  
  "asc" or "desc". Leave as null for default sorting
- skip: number
  
  Number of rows to skip. Leave as -1 for no skip
- limit: number
  
  Limit of results. Leave as -1 for no limit
- projection: Set<string>
  
  List of fields to fetch from the table. Leave as null to fetch them all.
- queryExtraOptions: QueryExtraOptions
  
  Additional query options
- each: ((row: any) => Promise<void>)
  
  Function to parse each row
  - - (row: any): Promise<void>
    - Parameters
      
      row: any
      
      Returns Promise<void>
Returns Promise<void>
- Defined in dao.ts:73

`Static` findStreamSync

findStreamSync(source: string, table: string, filter: GenericFilter, sortBy: string, sortDir: SortDirection, skip: number, limit: number, projection: Set<string>, queryExtraOptions: QueryExtraOptions, each: ((row: any) => void)): Promise<void>
Finds rows (stream) / Sync
Parameters
- source: string
  
  Data source name
- table: string
  
  Table name
- filter: GenericFilter
  
  Filter to apply
- sortBy: string
  
  Sort results by this field. Leave as null for default sorting
- sortDir: SortDirection
  
  "asc" or "desc". Leave as null for default sorting
- skip: number
  
  Number of rows to skip. Leave as -1 for no skip
- limit: number
  
  Limit of results. Leave as -1 for no limit
- projection: Set<string>
  
  List of fields to fetch from the table. Leave as null to fetch them all.
- queryExtraOptions: QueryExtraOptions
  
  Additional query options
- each: ((row: any) => void)
  
  Function to parse each row
  - - (row: any): void
    - Parameters
      
      row: any
      
      Returns void
Returns Promise<void>
- Defined in dao.ts:90

`Static` getDriver

getDriver(s: string): DataSourceDriver
Resolves and returns the current database driver.

Returns
The driver
Parameters
- s: string
  
  The name of the data source
Returns DataSourceDriver
- Defined in dao.ts:21

`Static` increment

increment(source: string, table: string, keyName: string, keyValue: any, prop: string, inc: number): Promise<void>
Atomic increment
Parameters
- source: string
  
  Data source name
- table: string
  
  Table name
- keyName: string
  
  Key name
- keyValue: any
  
  Key value
- prop: string
  
  Field to increment
- inc: number
  
  Amount to increment
Returns Promise<void>
- Defined in dao.ts:167

`Static` insertInstance

insertInstance(source: string, table: string, row: any): Promise<void>
Insert instance
Parameters
- source: string
  
  Data source name
- table: string
  
  Table name
- row: any
  
  Row to insert
Returns Promise<void>
- Defined in dao.ts:123

`Static` insertInstances

insertInstances(source: string, table: string, rows: any[]): Promise<void>
Insert instances
Parameters
- source: string
  
  Data source name
- table: string
  
  Table name
- rows: any[]
  
  Rows to insert
Returns Promise<void>
- Defined in dao.ts:133

`Static` sum

sum(source: string, table: string, filter: GenericFilter, id: string, field: string): Promise<number>
Aggregation
Parameters
- source: string
  
  Data source name
- table: string
  
  Table name
- filter: GenericFilter
  
  Filter to apply
- id: string
  
  Primary Key name
- field: string
  
  Field to aggregate
Returns Promise<number>
- Defined in dao.ts:113

`Static` updateMany

updateMany(source: string, table: string, filter: GenericFilter, updated: GenericRowUpdate): Promise<number>
Updates rows
Parameters
- source: string
  
  Data source name
- table: string
  
  Table name
- filter: GenericFilter
  
  Filter to apply
- updated: GenericRowUpdate
  
  Updated row
Returns Promise<number>
- Defined in dao.ts:154

Class DataAccessObject

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

source: string

table: string

pk: string

row: any

Returns DataAccessObject

Properties

original

pk

ref

source

table

Methods

changeRef

Parameters

row: any

Returns void

delete

Returns

Returns Promise<boolean>

increment

Parameters

field: string

inc: number

Returns Promise<void>

insert

Returns Promise<void>

save

Returns

Parameters

Optional condition: DataFilter<any>

Returns Promise<boolean>

Static count

Parameters

source: string

table: string

filter: GenericFilter

queryExtraOptions: QueryExtraOptions

Returns Promise<number>

Static deleteMany

Parameters

source: string

table: string

filter: GenericFilter

Returns Promise<number>

Static find

Parameters

source: string

table: string

filter: GenericFilter

sortBy: string

sortDir: SortDirection

skip: number

limit: number

projection: Set<string>

queryExtraOptions: QueryExtraOptions

Returns Promise<any[]>

Static findByKey

Parameters

source: string

table: string

keyName: string

keyValue: any

Returns Promise<any>

Static findStream

Parameters

source: string

table: string

filter: GenericFilter

sortBy: string

sortDir: SortDirection

skip: number

`Optional` condition: DataFilter<any>

`Static` count

`Static` deleteMany

`Static` find

`Static` findByKey

`Static` findStream

`Static` findStreamSync

`Static` getDriver

`Static` increment

`Static` insertInstance

`Static` insertInstances

`Static` sum

`Static` updateMany