Class Query<M, T>

Collects conditions to query

Type Parameters

M extends BaseModel
T = M

Implements

QuerySingle<M, T>
QueryArray<M, T>

Index

Constructors

constructor

Constructors

constructor

new Query<M, T>(model): Query<M, T>
Creates a query instance
Type Parameters
- M extends BaseModel
- T = M
Parameters
- model: typeof BaseModel
Returns Query<M, T>
- Defined in packages/cormo/src/query.ts:203

Methods

cache

cache(options): this
Cache result.

If cache of key exists, actual query does not performed. If cache does not exist, query result will be saved in cache.

Redis is used to cache.
Parameters
- options: undefined | {
      key: string;
      refresh?: boolean;
      ttl: number;
  }
Returns this
Implementation of QueryArray.cache
- Defined in packages/cormo/src/query.ts:491

clone

clone(): Query<M, T>
Returns Query<M, T>
Implementation of QueryArray.clone
- Defined in packages/cormo/src/query.ts:221

count

count(): Promise<number>
Executes the query as a count operation

Returns Promise<number>
See
AdapterBase::count
Implementation of QueryArray.count
- Defined in packages/cormo/src/query.ts:603

delete

delete(options?): Promise<number>
Executes the query as a delete operation
Parameters
- Optionaloptions: any
Returns Promise<number>
See
AdapterBase::delete
Implementation of QueryArray.delete
- Defined in packages/cormo/src/query.ts:664

distinct

distinct(): this
Returns distinct records

Returns this
Implementation of QueryArray.distinct
- Defined in packages/cormo/src/query.ts:403

endif

endif(): Query<M, T>
Ends last if

Returns Query<M, T>
Chainable
See
Query::if
Implementation of QueryArray.endif
- Defined in packages/cormo/src/query.ts:474

exec

exec(options?): Promise<any>
Executes the query
Parameters
- Optionaloptions: {
  skip_log?: boolean;
  }
  - Optionalskip_log?: boolean
Returns Promise<any>
See
- AdapterBase::findById
- AdapterBase::find
Implementation of QueryArray.exec
- Defined in packages/cormo/src/query.ts:530

explain

explain(): Promise<any>
Explains the query

Returns Promise<any>
Implementation of QueryArray.explain
- Defined in packages/cormo/src/query.ts:575

find

find(id): QuerySingle<M, T>
Finds a record by id
Parameters
- id: CormoTypesRecordID
Returns QuerySingle<M, T>
Implementation of QueryArray.find
- Defined in packages/cormo/src/query.ts:236
find(id): QueryArray<M, T>
Parameters
- id: CormoTypesRecordID[]
Returns QueryArray<M, T>
Implementation of QueryArray.find
- Defined in packages/cormo/src/query.ts:237

findPreserve

findPreserve(ids): QueryArray<M, T>
Finds records by ids while preserving order.
Parameters
- ids: CormoTypesRecordID[]
Returns QueryArray<M, T>
Implementation of QueryArray.findPreserve
- Defined in packages/cormo/src/query.ts:255

group

group<U>(group_by, fields?): QuerySingle<M, U>
Groups result records
Type Parameters
- U
Parameters
- group_by: null | string | string[]
- Optionalfields: object
Returns QuerySingle<M, U>
Implementation of QueryArray.group
- Defined in packages/cormo/src/query.ts:343
group<U>(group_by, fields?): QueryArray<M, U>
Type Parameters
- U
Parameters
- group_by: null | string | string[]
- Optionalfields: object
Returns QueryArray<M, U>
Implementation of QueryArray.group
- Defined in packages/cormo/src/query.ts:344

if

if(condition): this
Makes a part of the query chain conditional
Parameters
- condition: boolean
Returns this
See
Query::endif
Implementation of QueryArray.if
- Defined in packages/cormo/src/query.ts:463

include

include(column, select?): this
Returns associated objects also
Parameters
- column: string
- Optionalselect: string
Returns this
Implementation of QueryArray.include
- Defined in packages/cormo/src/query.ts:502

index_hint

index_hint(hint): this
Parameters
- hint: string
Returns this
Implementation of QueryArray.index_hint
- Defined in packages/cormo/src/query.ts:520

join

join(model_class, options?): this
(inner) join
Parameters
- model_class: typeof BaseModel
- Optionaloptions: {
      alias?: string;
      base_column?: string;
      join_column?: string;
  }
  - Optionalalias?: string
  - Optionalbase_column?: string
  - Optionaljoin_column?: string
Returns this
Implementation of QueryArray.join
- Defined in packages/cormo/src/query.ts:363

lean

lean(lean?): this
Returns raw instances instead of model instances
Parameters
- lean: boolean = true
Returns this
See
Query::exec
Implementation of QueryArray.lean
- Defined in packages/cormo/src/query.ts:451

left_outer_join

left_outer_join(model_class, options?): this
left outer join
Parameters
- model_class: typeof BaseModel
- Optionaloptions: {
      alias?: string;
      base_column?: string;
      join_column?: string;
  }
  - Optionalalias?: string
  - Optionalbase_column?: string
  - Optionaljoin_column?: string
Returns this
Implementation of QueryArray.left_outer_join
- Defined in packages/cormo/src/query.ts:383

limit

limit(limit): this
Sets limit of query
Parameters
- limit: number
Returns this
Implementation of QueryArray.limit
- Defined in packages/cormo/src/query.ts:428

near

near(target): this
Finds records near target
Parameters
- target: object
Returns this
Implementation of QueryArray.near
- Defined in packages/cormo/src/query.ts:268

one

one(): this
Returns only one record (or null if does not exists).

This is different from limit(1). limit(1) returns array of length 1 while this returns an instance.

Returns this
Implementation of QueryArray.one
- Defined in packages/cormo/src/query.ts:416

order

order(orders?): this
Specifies orders of result
Parameters
- Optionalorders: string
Returns this
Implementation of QueryArray.order
- Defined in packages/cormo/src/query.ts:332

select

select<K>(columns?): QuerySingle<M, Pick<M, K>>
Selects columns for result
Type Parameters
- K extends string | number | symbol
Parameters
- Optionalcolumns: string | string[]
Returns QuerySingle<M, Pick<M, K>>
Implementation of QueryArray.select
- Defined in packages/cormo/src/query.ts:296
select<K>(columns?): QueryArray<M, Pick<M, K>>
Type Parameters
- K extends string | number | symbol
Parameters
- Optionalcolumns: string | string[]
Returns QueryArray<M, Pick<M, K>>
Implementation of QueryArray.select
- Defined in packages/cormo/src/query.ts:297

selectSingle

selectSingle<K>(column): QuerySingle<M, M[K]>
Type Parameters
- K extends string | number | symbol
Parameters
- column: K
Returns QuerySingle<M, M[K]>
Implementation of QueryArray.selectSingle
- Defined in packages/cormo/src/query.ts:318
selectSingle<K>(column): QueryArray<M, M[K]>
Type Parameters
- K extends string | number | symbol
Parameters
- column: K
Returns QueryArray<M, M[K]>
Implementation of QuerySingle.selectSingle
- Defined in packages/cormo/src/query.ts:319

skip

skip(skip): this
Sets skip of query
Parameters
- skip: number
Returns this
Implementation of QueryArray.skip
- Defined in packages/cormo/src/query.ts:439

stream

stream(): Readable
Executes the query and returns a readable stream

Returns Readable
See
- AdapterBase::findById
- AdapterBase::find
Implementation of QueryArray.stream
- Defined in packages/cormo/src/query.ts:554

then

then<TResult1, TResult2>(onfulfilled?, onrejected?): PromiseLike<TResult1 | TResult2>
Executes the query as a promise (.then == .exec().then)
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optionalonfulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>) | ((value: T[]) => TResult1 | PromiseLike<TResult1>)
- Optionalonrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)
Returns PromiseLike<TResult1 | TResult2>
Implementation of QueryArray.then
- Defined in packages/cormo/src/query.ts:585

transaction

transaction(transaction?): this
Parameters
- Optionaltransaction: Transaction
Returns this
Implementation of QueryArray.transaction
- Defined in packages/cormo/src/query.ts:510

update

update(updates): Promise<number>
Executes the query as a update operation
Parameters
- updates: any
Returns Promise<number>
See
AdapterBase::update
Implementation of QueryArray.update
- Defined in packages/cormo/src/query.ts:617

upsert

upsert(updates, options?): Promise<void>
Executes the query as an insert or update operation
Parameters
- updates: any
- Optionaloptions: {
  ignore_on_update: string[];
  }
  - ignore_on_update: string[]
Returns Promise<void>
See
AdapterBase::upsert
Implementation of QueryArray.upsert
- Defined in packages/cormo/src/query.ts:638

using

using(node): this
Parameters
- node: "master" | "read"
Returns this
Implementation of QueryArray.using
- Defined in packages/cormo/src/query.ts:515

where

where(condition?): this
Finds records by condition
Parameters
- Optionalcondition: object
Returns this
Implementation of QueryArray.where
- Defined in packages/cormo/src/query.ts:279

Class Query<M, T>

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Query<M, T>

Methods

cache

Parameters

Returns this

clone

Returns Query<M, T>

count

Returns Promise<number>

See

delete

Parameters

Returns Promise<number>

See

distinct

Returns this

endif

Returns Query<M, T>

Chainable

See

exec

Parameters

Optionalskip_log?: boolean

Returns Promise<any>

See

explain

Returns Promise<any>

find

Parameters

Returns QuerySingle<M, T>

Parameters

Returns QueryArray<M, T>

findPreserve

Parameters

Returns QueryArray<M, T>

group

Type Parameters

Parameters

Returns QuerySingle<M, U>

Type Parameters

Parameters

Returns QueryArray<M, U>

if

Parameters

Returns this

See

include

Parameters

Returns this

index_hint

Parameters

Returns this

join

Parameters

Optionalalias?: string

Optionalbase_column?: string

Optionaljoin_column?: string

Returns this

lean

Parameters

Returns this

See

left_outer_join

Parameters

Optionalalias?: string

Optionalbase_column?: string

Optionaljoin_column?: string

Returns this

limit

Parameters

`Optional`skip_log?: boolean

`Optional`alias?: string

`Optional`base_column?: string

`Optional`join_column?: string

`Optional`alias?: string

`Optional`base_column?: string

`Optional`join_column?: string