Class Builder<T>

An abstract Query which allows retrieving results

Type Parameters

T extends Entity

Hierarchy

Query<T>
query.Condition<T>
- Builder

Index

Constructors

constructor

new Builder<T>(entityManager: EntityManager, resultClass: Class<T>): Builder<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 Builder<T>
Inherited from Query.constructor
- 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

addFilter

addFilter(field: null | string, filter: null | string, value: any): Filter<T>
Parameters
- field: null | string
- filter: null | string
- value: any
Returns Filter<T>
Inherited from Condition.addFilter
- Defined in lib/query/Builder.ts:85

addLimit

addLimit(limit: number): Filter<T>
Parameters
- limit: number
Returns Filter<T>
Inherited from Query.addLimit
- Defined in lib/query/Builder.ts:93

addOffset

addOffset(offset: number): Filter<T>
Parameters
- offset: number
Returns Filter<T>
Inherited from Query.addOffset
- Defined in lib/query/Builder.ts:89

addOperator

addOperator(operator: string, args: Node<T>[]): Operator<T>
Parameters
- operator: string
- args: Node<T>[]
Returns Operator<T>
- Defined in lib/query/Builder.ts:67

addOrder

addOrder(fieldOrSort: string | {
[field: string]: 1 | -1;
}, order?: 1 | -1): Filter<T>
Parameters
- fieldOrSort: string | {
  [field: string]: 1 | -1;
  }
- Optional order: 1 | -1
Returns Filter<T>
Inherited from Query.addOrder
- Defined in lib/query/Builder.ts:81

and

and(...args: (Query<T> | Query<T>[])[]): Operator<T>
Joins the conditions by an logical AND

Returns
Returns a new query which joins the given queries by a logical AND
Parameters
- Rest ...args: (Query<T> | Query<T>[])[]
  
  The query nodes to join
Returns Operator<T>
- Defined in lib/query/Builder.ts:22

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>
Inherited from Query.ascending
- Defined in lib/query/Query.ts:27

between

between(field: string, greaterValue: string | number | Date | Entity, lessValue: string | number | Date | Entity): Filter<T>
Adds a between filter to the field. This is a shorthand for an less than and greater than filter.

Returns
The resulting Query
Parameters
- field: string
  
  The field to filter
- greaterValue: string | number | Date | Entity
  
  The field value must be greater than this value
- lessValue: string | number | Date | Entity
  
  The field value must be less than this value
Returns Filter<T>
Inherited from Condition.between
- Defined in lib/query/Condition.ts:90

containsAll

containsAll(field: string, ...args: any[]): Filter<T>
Adds a contains all filter to the collection field

The collection must contain all the given values.

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/all/
Parameters
- field: string
  
  The field to filter
- Rest ...args: any[]
  
  The field value or values to filter
Returns Filter<T>
Inherited from Condition.containsAll
- Defined in lib/query/Condition.ts:166

containsAny

containsAny(field: string, ...args: any[]): Filter<T>
The collection must contains one of the given values

Adds a contains any filter to the collection field. Alias for in.

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/in/
Parameters
- field: string
  
  The field to filter
- Rest ...args: any[]
  
  The field value or values to filter
Returns Filter<T>
Inherited from Condition.containsAny
- Defined in lib/query/Condition.ts:324

count

count(doneCallback?: CountCallback, failCallback?: FailCallback): Promise<any>
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<any>
Inherited from Query.count
- Defined in lib/query/Builder.ts:63

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>
Inherited from Query.descending
- Defined in lib/query/Query.ts:36

eq

eq(field: string, value: any): Filter<T>
Adds a equal filter to the field

All other other filters on the field will be discarded.

Method
Parameters
- field: string
  
  The field to filter
- value: any
  
  The value used to filter
Returns Filter<T>
Inherited from Condition.eq
- Defined in lib/query/Condition.ts:246

equal

equal(field: string, value: any): Filter<T>
Adds a equal filter to the field. All other other filters on the field will be discarded

Returns
The resulting Query
Parameters
- field: string
  
  The field to filter
- value: any
  
  The value used to filter
Returns Filter<T>
Inherited from Condition.equal
- Defined in lib/query/Condition.ts:26

ge

ge(field: string, value: string | number | Date | Entity): Filter<T>
Adds a greater than or equal to filter to the field

Shorthand for greaterThanOrEqualTo.

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/gte/
Parameters
- field: string
  
  The field to filter
- value: string | number | Date | Entity
  
  The value used to filter
Returns Filter<T>
Inherited from Condition.ge
- Defined in lib/query/Condition.ts:310

greaterThan

greaterThan(field: string, value: string | number | Date | Entity): Filter<T>
Adds a greater than filter to the field

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/gt/
Parameters
- field: string
  
  The field to filter
- value: string | number | Date | Entity
  
  The value used to filter
Returns Filter<T>
Inherited from Condition.greaterThan
- Defined in lib/query/Condition.ts:48

greaterThanOrEqualTo

greaterThanOrEqualTo(field: string, value: string | number | Date | Entity): Filter<T>
Adds a greater than or equal to filter to the field

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/gte/
Parameters
- field: string
  
  The field to filter
- value: string | number | Date | Entity
  
  The value used to filter
Returns Filter<T>
Inherited from Condition.greaterThanOrEqualTo
- Defined in lib/query/Condition.ts:59

gt

gt(field: string, value: string | number | Date | Entity): Filter<T>
Adds a greater than filter to the field

Shorthand for greaterThan.

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/gt/
Parameters
- field: string
  
  The field to filter
- value: string | number | Date | Entity
  
  The value used to filter
Returns Filter<T>
Inherited from Condition.gt
- Defined in lib/query/Condition.ts:297

in

in(field: string, ...args: any[]): Filter<T>
Adds a “in” filter to the field

The field value must be equal to one of the given values.

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/in/
Parameters
- field: string
  
  The field to filter
- Rest ...args: any[]
  
  The field value or values to filter
Returns Filter<T>
Inherited from Condition.in
- Defined in lib/query/Condition.ts:107
in(field: string, ...args: any[]): Filter<T>
Adds an “in” filter to the field

The field value must be equal to one of the given values.

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/in/
Parameters
- field: string
  
  The field to filter
- Rest ...args: any[]
  
  The field value or values to filter
Returns Filter<T>
Inherited from Condition.in
- Defined in lib/query/Condition.ts:120

isNotNull

isNotNull(field: string): Filter<T>
Adds a “is not null” filter to the field

The field value must not be null.

Returns
The resulting Query
Parameters
- field: string
  
  The field to filter
Returns Filter<T>
Inherited from Condition.isNotNull
- Defined in lib/query/Condition.ts:153

isNull

isNull(field: string): Filter<T>
Adds a “is null” filter to the field

The field value must be null.

Returns
The resulting Query
Parameters
- field: string
  
  The field to filter
Returns Filter<T>
Inherited from Condition.isNull
- Defined in lib/query/Condition.ts:143

le

le(field: string, value: string | number | Date | Entity): Filter<T>
Adds a less than or equal to filter to the field

Shorthand for lessThanOrEqualTo.

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/lte/
Parameters
- field: string
  
  The field to filter
- value: string | number | Date | Entity
  
  The value used to filter
Returns Filter<T>
Inherited from Condition.le
- Defined in lib/query/Condition.ts:284

lessThan

lessThan(field: string, value: string | number | Date | Entity): Filter<T>
Adds a less than filter to the field

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/lt/
Parameters
- field: string
  
  The field to filter
- value: string | number | Date | Entity
  
  The value used to filter
Returns Filter<T>
Inherited from Condition.lessThan
- Defined in lib/query/Condition.ts:70

lessThanOrEqualTo

lessThanOrEqualTo(field: string, value: string | number | Date | Entity): Filter<T>
Adds a less than or equal to filter to the field

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/lte/
Parameters
- field: string
  
  The field to filter
- value: string | number | Date | Entity
  
  The value used to filter
Returns Filter<T>
Inherited from Condition.lessThanOrEqualTo
- Defined in lib/query/Condition.ts:81

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>
Inherited from Query.limit
- Defined in lib/query/Query.ts:78

lt

lt(field: string, value: string | number | Date | Entity): Filter<T>
Adds a less than filter to the field

Shorthand for lessThan.

Method

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/lt/
Parameters
- field: string
  
  The field to filter
- value: string | number | Date | Entity
  
  The value used to filter
Returns Filter<T>
Inherited from Condition.lt
- Defined in lib/query/Condition.ts:271

matches

matches(field: string, regExp: string | RegExp): Filter<T>
Adds a regular expression filter to the field

The field value must matches the regular expression.

Note: Only anchored expressions (Expressions that starts with an ^) and the multiline flag are supported.

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/regex/
Parameters
- field: string
  
  The field to filter
- regExp: string | RegExp
  
  The regular expression of the filter
Returns Filter<T>
Inherited from Condition.matches
- Defined in lib/query/Condition.ts:194

mod

mod(field: string, divisor: number, remainder: number): Filter<T>
Adds a modulo filter to the field

The field value divided by divisor must be equal to the remainder.

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/mod/
Parameters
- field: string
  
  The field to filter
- divisor: number
  
  The divisor of the modulo filter
- remainder: number
  
  The remainder of the modulo filter
Returns Filter<T>
Inherited from Condition.mod
- Defined in lib/query/Condition.ts:180

ne

ne(field: string, value: any): Filter<T>
Adds a not equal filter to the field

Method

See
http://docs.mongodb.org/manual/reference/operator/query/ne/
Parameters
- field: string
  
  The field to filter
- value: any
  
  The value used to filter
Returns Filter<T>
Inherited from Condition.ne
- Defined in lib/query/Condition.ts:257

near

near(field: string, geoPoint: GeoPoint, maxDistance: number): Filter<T>
Adds a geopoint based near filter to the GeoPoint field

The GeoPoint must be within the maximum distance to the given GeoPoint. Returns from nearest to farthest.

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/nearSphere/
Parameters
- field: string
  
  The field to filter
- geoPoint: GeoPoint
  
  The GeoPoint to filter
- maxDistance: number
  
  Tha maximum distance to filter in meters
Returns Filter<T>
Inherited from Condition.near
- Defined in lib/query/Condition.ts:222

nor

nor(...args: (Query<T> | Query<T>[])[]): Operator<T>
Joins the conditions by an logical NOR

Returns
Returns a new query which joins the given queries by a logical NOR
Parameters
- Rest ...args: (Query<T> | Query<T>[])[]
  
  The query nodes to join
Returns Operator<T>
- Defined in lib/query/Builder.ts:40

notEqual

notEqual(field: string, value: any): Filter<T>
Adds a not equal filter to the field

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/ne/
Parameters
- field: string
  
  The field to filter
- value: any
  
  The value used to filter
Returns Filter<T>
Inherited from Condition.notEqual
- Defined in lib/query/Condition.ts:37

notIn

notIn(field: string, ...args: any[]): Filter<T>
Adds a “not in” filter to the field

The field value must not be equal to any of the given values.

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/nin/
Parameters
- field: string
  
  The field to filter
- Rest ...args: any[]
  
  The field value or values to filter
Returns Filter<T>
Inherited from Condition.notIn
- Defined in lib/query/Condition.ts:133

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>
Inherited from Query.offset
- Defined in lib/query/Query.ts:63

or

or(...args: (Query<T> | Query<T>[])[]): Operator<T>
Joins the conditions by an logical OR

Returns
Returns a new query which joins the given queries by a logical OR
Parameters
- Rest ...args: (Query<T> | Query<T>[])[]
  
  The query nodes to join
Returns Operator<T>
- Defined in lib/query/Builder.ts:31

resultList

resultList(options?: ResultOptions | ResultListCallback<T>, doneCallback?: FailCallback | 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 | ResultListCallback<T>
  
  The query options
- Optional doneCallback: FailCallback | ResultListCallback<T>
  
  Called when the operation succeed.
- Optional failCallback: FailCallback
  
  Called when the operation failed.
Returns Promise<T[]>
Inherited from Query.resultList
- Defined in lib/query/Builder.ts:47

singleResult

singleResult(options?: ResultOptions | SingleResultCallback<T>, doneCallback?: FailCallback | 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 | SingleResultCallback<T>
  
  The query options
- Optional doneCallback: FailCallback | SingleResultCallback<T>
  
  Called when the operation succeed.
- Optional failCallback: FailCallback
  
  Called when the operation failed.
Returns Promise<null | T>
Inherited from Query.singleResult
- Defined in lib/query/Builder.ts:55

size

size(field: string, size: number): Filter<T>
Adds a size filter to the collection field

The collection must have exactly size members.

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/size/
Parameters
- field: string
  
  The field to filter
- size: number
  
  The collections size to filter
Returns Filter<T>
Inherited from Condition.size
- Defined in lib/query/Condition.ts:207

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>
Inherited from Query.sort
- Defined in lib/query/Query.ts:48

where

where(conditions: JsonMap): Filter<T>
An object that contains filter rules which will be merged with the current filters of this query

Returns
The resulting Query
Parameters
- conditions: JsonMap
  
  Additional filters for this query
Returns Filter<T>
Inherited from Condition.where
- Defined in lib/query/Condition.ts:18

withinPolygon

withinPolygon(field: string, ...geoPoints: GeoPoint[] | GeoPoint[][]): Filter<T>
Adds a GeoPoint based polygon filter to the GeoPoint field

The GeoPoint must be contained within the given polygon.

Returns
The resulting Query

See
http://docs.mongodb.org/manual/reference/operator/query/geoWithin/
Parameters
- field: string
  
  The field to filter
- Rest ...geoPoints: GeoPoint[] | GeoPoint[][]
  
  The geoPoints that describes the polygon of the filter
Returns Filter<T>
Inherited from Condition.withinPolygon
- Defined in lib/query/Condition.ts:235

Class Builder<T>

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 Builder<T>

Properties

Readonly entityManager

Readonly resultClass

Static Readonly MAX_URI_SIZE

Methods

addFilter

Parameters

field: null | string

filter: null | string

value: any

Returns Filter<T>

addLimit

Parameters

limit: number

Returns Filter<T>

addOffset

Parameters

offset: number

Returns Filter<T>

addOperator

Parameters

operator: string

args: Node<T>[]

Returns Operator<T>

addOrder

Parameters

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

Optional order: 1 | -1

Returns Filter<T>

and

Returns

Parameters

Rest ...args: (Query<T> | Query<T>[])[]

Returns Operator<T>

ascending

Returns

Parameters

field: string

Returns Node<T>

between

Returns

Parameters

field: string

greaterValue: string | number | Date | Entity

lessValue: string | number | Date | Entity

Returns Filter<T>

containsAll

Returns

See

Parameters

field: string

Rest ...args: any[]

Returns Filter<T>

containsAny

Returns

See

Parameters

field: string

Rest ...args: any[]

Returns Filter<T>

count

Returns

Parameters

Optional doneCallback: CountCallback

`Readonly` entityManager

`Readonly` resultClass

`Static` `Readonly` MAX_URI_SIZE

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

`Optional` order: 1 | -1

`Rest` ...args: (Query<T> | Query<T>[])[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` doneCallback: CountCallback

`Optional` failCallback: FailCallback

`Rest` ...args: any[]

`Rest` ...args: any[]