Class ZDatabaseQuery<R>

Represents an implementation of the IZDatabaseQuery interface.

Type parameters

R

Hierarchy

ZDatabaseQuery

Implements

IZDatabaseQuery<R>

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new ZDatabaseQuery<R>(_do: (query: ZDatabaseQuery<R>) => Promise<R>): ZDatabaseQuery<R>

- Defined in packages/works.dal/src/query/database-query.class.ts:63
Initializes a new instance of this object.

Type parameters
- R
Parameters
- _do: (query: ZDatabaseQuery<R>) => Promise<R>
  
  The invoke action for the query.
  - - (query: ZDatabaseQuery<R>): Promise<R>
    - Parameters
      - query: ZDatabaseQuery<R>
      Returns Promise<R>
Returns ZDatabaseQuery<R>

Accessors

$filter

get $filter(): Filter<any>

Implementation of IZDatabaseQuery.$filter
- Defined in packages/works.dal/src/query/database-query.class.ts:18
Gets the current filter.

Returns Filter<any>
The current filter.

$join

get $join(): JoinCriteria

Implementation of IZDatabaseQuery.$join
- Defined in packages/works.dal/src/query/database-query.class.ts:54
Gets the current join.

Returns JoinCriteria
The current join.

$page

get $page(): number

Implementation of IZDatabaseQuery.$page
- Defined in packages/works.dal/src/query/database-query.class.ts:36
Gets the current page.

Returns number
The current page.

$size

get $size(): number

Implementation of IZDatabaseQuery.$size
- Defined in packages/works.dal/src/query/database-query.class.ts:45
Gets the current page size.

Returns number
The current page size.

$sort

get $sort(): SortCriteria

Implementation of IZDatabaseQuery.$sort
- Defined in packages/works.dal/src/query/database-query.class.ts:27
Gets the current sort.

Returns SortCriteria
The current sort.

Methods

copy

copy(other: IZDatabaseQuery<R>): ZDatabaseQuery<R>

Implementation of IZDatabaseQuery.copy
- Defined in packages/works.dal/src/query/database-query.class.ts:72
Copies another query into this query.

Parameters
- other: IZDatabaseQuery<R>
  
  The query to copy.
Returns ZDatabaseQuery<R>
This object.

filter

filter(filter: Filter<any>): ZDatabaseQuery<R>

Implementation of IZDatabaseQuery.filter
- Defined in packages/works.dal/src/query/database-query.class.ts:88
Sets the filter.

Parameters
- filter: Filter<any>
  
  The filter to use.
Returns ZDatabaseQuery<R>
This object.

join

join<L, F>(from: string, local: keyof L, foreign: keyof F, as: string): ZDatabaseQuery<R>

Implementation of IZDatabaseQuery.join
- Defined in packages/works.dal/src/query/database-query.class.ts:164
Adds a join criteria.

Type parameters
- L
- F
Parameters
- from: string
  
  The collection to join on.
- local: keyof L
  
  The local field to match.
- foreign: keyof F
  
  The field from 'from' to match on.
- as: string
  
  The output name of the field.
Returns ZDatabaseQuery<R>
This object.

joins

joins(join: JoinCriteria): ZDatabaseQuery<R>

Implementation of IZDatabaseQuery.joins
- Defined in packages/works.dal/src/query/database-query.class.ts:149
Sets criteria to join on.

Parameters
- join: JoinCriteria
  
  The join criteria.
Returns ZDatabaseQuery<R>
This object.

page

page(page: number): ZDatabaseQuery<R>

Implementation of IZDatabaseQuery.page
- Defined in packages/works.dal/src/query/database-query.class.ts:125
Sets the page.

Parameters
- page: number
  
  The 0 based page index.
Returns ZDatabaseQuery<R>
This object.

run

run(): Promise<R>

Implementation of IZDatabaseQuery.run
- Defined in packages/works.dal/src/query/database-query.class.ts:174
Invokes the action.

Returns Promise<R>
A promise that when resolved, has returned the results of the query.

size

size(size: number): ZDatabaseQuery<R>

Implementation of IZDatabaseQuery.size
- Defined in packages/works.dal/src/query/database-query.class.ts:137
Sets the page size.

Parameters
- size: number
  
  The page size.
Returns ZDatabaseQuery<R>
This object.

sort

sort(key: string, direction: SortDirection): ZDatabaseQuery<R>

Implementation of IZDatabaseQuery.sort
- Defined in packages/works.dal/src/query/database-query.class.ts:113
Updates the current sort criteria by adding one.

Parameters
- key: string
  
  The sort key.
- direction: SortDirection
  
  The direction to sort.
Returns ZDatabaseQuery<R>
This object.

sorts

sorts(sort: SortCriteria): ZDatabaseQuery<R>

Implementation of IZDatabaseQuery.sorts
- Defined in packages/works.dal/src/query/database-query.class.ts:100
Sets the entire sort criteria.

Parameters
- sort: SortCriteria
  
  The sort criteria.
Returns ZDatabaseQuery<R>
This object.

Generated using TypeDoc