Class Query<T>`Abstract`

An abstract Query which allows retrieving results

Type Parameters

T extends Entity

Hierarchy

Query
- Builder
- Node

Index

Constructors

constructor

new Query<T>(entityManager: EntityManager, resultClass: Class<T>): Query<T>
Type Parameters
- T extends Entity<T>
Parameters
- entityManager: EntityManager
  
  The owning EntityManager of this query
- resultClass: Class<T>
  
  The result class of this query
Returns Query<T>
- Defined in lib/query/Query.ts:17

Properties

`Readonly` entityManager

entityManager: EntityManager

The owning EntityManager of this query

`Readonly` resultClass

resultClass: Class<T>

The result class of this query

`Static` `Readonly` MAX_URI_SIZE

MAX_URI_SIZE: 2000 = 2000

Methods

`Abstract` addLimit

addLimit(limit: number): Node<T>
Parameters
- limit: number
Returns Node<T>
- Defined in lib/query/Query.ts:152

`Abstract` addOffset

addOffset(offset: number): Node<T>
Parameters
- offset: number
Returns Node<T>
- Defined in lib/query/Query.ts:150

`Abstract` addOrder

addOrder(field: string, order: 1 | -1): Node<T>
Parameters
- field: string
- order: 1 | -1
Returns Node<T>
- Defined in lib/query/Query.ts:146
addOrder(order: {
[field: string]: 1 | -1;
}): Node<T>
Parameters
- order: {
  [field: string]: 1 | -1;
  }
  - [field: string]: 1 | -1
Returns Node<T>
- Defined in lib/query/Query.ts:148

ascending

ascending(field: string): Node<T>
Add an ascending sort for the specified field to this query

Returns
The resulting Query
Parameters
- field: string
  
  The field to sort
Returns Node<T>
- Defined in lib/query/Query.ts:27

`Abstract` count

count(doneCallback?: CountCallback, failCallback?: FailCallback): Promise<number>
Execute the query that returns the matching objects count.

Returns
The total number of matched objects
Parameters
- Optional doneCallback: CountCallback
  
  Called when the operation succeed.
- Optional failCallback: FailCallback
  
  Called when there is a server-side error
Returns Promise<number>
- Defined in lib/query/Query.ts:144

descending

descending(field: string): Node<T>
Add an decending sort for the specified field to this query

Returns
The resulting Query
Parameters
- field: string
  
  The field to sort
Returns Node<T>
- Defined in lib/query/Query.ts:36

limit

limit(limit: number): Node<T>
Sets the limit of this query, i.e hox many objects should be returnd

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/method/cursor.limit/
Parameters
- limit: number
  
  The limit of this query
Returns Node<T>
- Defined in lib/query/Query.ts:78

offset

offset(offset: number): Node<T>
Sets the offset of the query, i.e. how many elements should be skipped

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/method/cursor.skip/
Parameters
- offset: number
  
  The offset of this query
Returns Node<T>
- Defined in lib/query/Query.ts:63

`Abstract` resultList

resultList(options?: ResultOptions, doneCallback?: ResultListCallback<T>, failCallback?: FailCallback): Promise<T[]>
Execute the query and return the query results as a List

Note: All local unsaved changes on matching objects, will be discarded.

Returns
A promise that will be resolved with the query result as a list
Parameters
- Optional options: ResultOptions
  
  The query options
- Optional doneCallback: ResultListCallback<T>
  
  Called when the operation succeed.
- Optional failCallback: FailCallback
  
  Called when the operation failed.
Returns Promise<T[]>
- Defined in lib/query/Query.ts:98
resultList(doneCallback?: ResultListCallback<T>, failCallback?: FailCallback): Promise<T[]>
Execute the query and return the query results as a List

Note: All local unsaved changes on matching objects, will be discarded.

Returns
A promise that will be resolved with the query result as a list
Parameters
- Optional doneCallback: ResultListCallback<T>
  
  Called when the operation succeed.
- Optional failCallback: FailCallback
  
  Called when the operation failed.
Returns Promise<T[]>
- Defined in lib/query/Query.ts:110

`Abstract` singleResult

singleResult(options?: ResultOptions, doneCallback?: SingleResultCallback<T>, failCallback?: FailCallback): Promise<null | T>
Execute the query that returns a single result

Note: All local unsaved changes on the matched object, will be discarded.

Returns
A promise that will be resolved with the query result as a single result
Parameters
- Optional options: ResultOptions
  
  The query options
- Optional doneCallback: SingleResultCallback<T>
  
  Called when the operation succeed.
- Optional failCallback: FailCallback
  
  Called when the operation failed.
Returns Promise<null | T>
- Defined in lib/query/Query.ts:124
singleResult(doneCallback?: SingleResultCallback<T>, failCallback?: FailCallback): Promise<null | T>
Execute the query that returns a single result

Note: All local unsaved changes on the matched object, will be discarded.

Returns
A promise that will be resolved with the query result as a single result
Parameters
- Optional doneCallback: SingleResultCallback<T>
  
  Called when the operation succeed.
- Optional failCallback: FailCallback
  
  Called when the operation failed.
Returns Promise<null | T>
- Defined in lib/query/Query.ts:136

sort

sort(sort: {
[field: string]: 1 | -1;
}): Node<T>
Sets the sort of the query and discard all existing paramaters

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/method/cursor.sort/
Parameters
- sort: {
  [field: string]: 1 | -1;
  }
  
  The new sort of the query which is an object whose keys are fields and the values are either +1 for ascending order or -1 for descending order
  - [field: string]: 1 | -1
Returns Node<T>
- Defined in lib/query/Query.ts:48

Class Query<T>Abstract

Type Parameters

T extends Entity

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends Entity<T>

Parameters

entityManager: EntityManager

resultClass: Class<T>

Returns Query<T>

Properties

Readonly entityManager

Readonly resultClass

Static Readonly MAX_URI_SIZE

Methods

Abstract addLimit

Parameters

limit: number

Returns Node<T>

Abstract addOffset

Parameters

offset: number

Returns Node<T>

Abstract addOrder

Parameters

field: string

order: 1 | -1

Returns Node<T>

Parameters

order: { [field: string]: 1 | -1; }

[field: string]: 1 | -1

Returns Node<T>

ascending

Returns

Parameters

field: string

Returns Node<T>

Abstract count

Returns

Parameters

Optional doneCallback: CountCallback

Optional failCallback: FailCallback

Returns Promise<number>

descending

Returns

Parameters

field: string

Returns Node<T>

limit

Returns

See

Parameters

limit: number

Returns Node<T>

offset

Returns

See

Parameters

offset: number

Returns Node<T>

Abstract resultList

Returns

Parameters

Optional options: ResultOptions

Optional doneCallback: ResultListCallback<T>

Optional failCallback: FailCallback

Returns Promise<T[]>

Returns

Parameters

Optional doneCallback: ResultListCallback<T>

Optional failCallback: FailCallback

Returns Promise<T[]>

Abstract singleResult

Returns

Class Query<T>`Abstract`

`Readonly` entityManager

`Readonly` resultClass

`Static` `Readonly` MAX_URI_SIZE

`Abstract` addLimit

`Abstract` addOffset

`Abstract` addOrder

order: {
[field: string]: 1 | -1;
}

`Abstract` count

`Optional` doneCallback: CountCallback

`Optional` failCallback: FailCallback

`Abstract` resultList

`Optional` options: ResultOptions

`Optional` doneCallback: ResultListCallback<T>

`Optional` failCallback: FailCallback

`Optional` doneCallback: ResultListCallback<T>

`Optional` failCallback: FailCallback

`Abstract` singleResult

`Optional` options: ResultOptions

`Optional` doneCallback: SingleResultCallback<T>

`Optional` failCallback: FailCallback

`Optional` doneCallback: SingleResultCallback<T>

`Optional` failCallback: FailCallback

sort: {
[field: string]: 1 | -1;
}