QueryBuilder | esix

Type parameters

T

Hierarchy

QueryBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

new QueryBuilder(ctor: ObjectType<T>): QueryBuilder

- Defined in query-builder.ts:51
Parameters
- ctor: ObjectType<T>
Returns QueryBuilder

Methods

average

average(key: string): Promise<number>

- Defined in query-builder.ts:62
Returns the average of all the values for the given key.

Parameters
- key: string
Returns Promise<number>

count

count(): Promise<number>

- Defined in query-builder.ts:83
Returns the number of documents matching the given query.

Example
```
const numberOfPayingCustomers = await Customer.where('hasPaidTheLastInvoice', true).count();
```
Returns Promise<number>

create

create(attributes: {}): Promise<string>

- Defined in query-builder.ts:94
Creates a new document with the given attributes.

internal

Parameters
- attributes: {}
  - [index: string]: any
Returns Promise<string>

delete

delete(): Promise<number>

- Defined in query-builder.ts:109
Deletes the Models matching the current query options.

Returns Promise<number>

Returns the number of models deleted.

find

find(id: string): Promise<T | null>

- Defined in query-builder.ts:139
Returns the model with the given id or null if there is no matching model.

Parameters
- id: string
Returns Promise<T | null>

findOne

findOne(query: Query): Promise<T | null>

- Defined in query-builder.ts:169
Returns the first model matching the query options.

internal

Parameters
- query: Query
Returns Promise<T | null>

first

first(): Promise<T | null>

- Defined in query-builder.ts:184
Returns the first model matching the query options.

Returns Promise<T | null>

get

get(): Promise<T[]>

- Defined in query-builder.ts:197
Returns an array of models matching the query options.

Returns Promise<T[]>

limit

limit(length: number): QueryBuilder<T>

- Defined in query-builder.ts:206
Limits the number of models returned.

Parameters
- length: number
Returns QueryBuilder<T>

max

max(key: string): Promise<number>

- Defined in query-builder.ts:217
Returns the largest value for the given key.

Parameters
- key: string
Returns Promise<number>

min

min(key: string): Promise<number>

- Defined in query-builder.ts:228
Returns the smallest value for the given key.

Parameters
- key: string
Returns Promise<number>

orderBy

orderBy(key: string, order?: "asc" | "desc"): QueryBuilder<T>

- Defined in query-builder.ts:240
Sorts the models by the given key.

Parameters
- key: string
  
  The key you want to sort by.
- Default value order: "asc" | "desc" = "asc"
  
  Defaults to ascending order.
Returns QueryBuilder<T>

percentile

percentile(key: string, n: number): Promise<number>

- Defined in query-builder.ts:256
Returns the nth percentile of all the values for the given key.

Parameters
- key: string
- n: number
Returns Promise<number>

pluck

pluck(...keys: string[]): Promise<any[]>

- Defined in query-builder.ts:280
The pluck method retrieves all of the values for a given key.

You may also specify how you wish the resulting collection to be keyed.

Example
```
await Posts.where('categoryId', 2).pluck('id');
// => [ '1', '2', '3' ]

await Products.where('size', 'large').pluck('price', 'name');
// => [ { name: 'Shirt 1', price: 14.99 } ]
```
Parameters
- Rest ...keys: string[]
Returns Promise<any[]>

save

save(attributes: Dictionary): Promise<string>

- Defined in query-builder.ts:314
Persist the provided attributes.

internal

Parameters
- attributes: Dictionary
Returns Promise<string>

sum

sum(key: string): Promise<number>

- Defined in query-builder.ts:336
Returns the sum of all the values for the given key.

Parameters
- key: string
Returns Promise<number>

where

where(query: Query): QueryBuilder<T>
where(key: string, value: any): QueryBuilder<T>

- Defined in query-builder.ts:348
Adds a constraint to the current query.

oaram

value

Parameters
- query: Query
Returns QueryBuilder<T>
- Defined in query-builder.ts:349
Parameters
- key: string
- value: any
Returns QueryBuilder<T>

whereIn

whereIn(fieldName: string, values: any[]): QueryBuilder<T>

- Defined in query-builder.ts:367
Returns all the models with fieldName in the array of values.

Parameters
- fieldName: string
- values: any[]
Returns QueryBuilder<T>

Generated using TypeDoc