Class Query<M, T>

Collects conditions to query

Type Parameters

M extends BaseModel
T = M

Implements

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

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

Properties

`Private` _adapter

_adapter: AdapterBase

`Private` _conditions

_conditions: Record<string, any>[]

`Private` _connection

_connection: Connection<AdapterBase>

`Private` _current_if

_current_if: boolean

`Private` _find_single_id

_find_single_id: boolean = false

`Private` _id

_id: any

`Private` _ifs

_ifs: boolean[]

`Private` _includes

_includes: {
column: string;
select?: string;
}[]

Type declaration

column: string
Optional select?: string

`Private` _model

_model: typeof BaseModel

`Private` _name

_name: string

`Private` _options

_options: QueryOptions

`Private` `Optional` _preserve_order_ids

_preserve_order_ids?: any[]

`Private` _used

_used: boolean = false

Methods

`Private` _addCondition

_addCondition(condition): void
Parameters
- condition: any
Returns void
- Defined in packages/cormo/src/query.ts:985

`Private` _doArchiveAndIntegrity

_doArchiveAndIntegrity(options): Promise<void>
Parameters
- options: any
Returns Promise<void>
- Defined in packages/cormo/src/query.ts:954

`Private` _doIntegrityActions

_doIntegrityActions(integrities, ids): Promise<void>
Parameters
- integrities: any
- ids: any
Returns Promise<void>
- Defined in packages/cormo/src/query.ts:938

`Private` _exec

_exec(find_options, options?): Promise<any>
Parameters
- find_options: AdapterFindOptions
- Optional options: {
  skip_log?: boolean;
  }
  - Optional skip_log?: boolean
Returns Promise<any>
- Defined in packages/cormo/src/query.ts:679

`Private` _execAndInclude

_execAndInclude(options?): Promise<any>
Parameters
- Optional options: {
  skip_log?: boolean;
  }
  - Optional skip_log?: boolean
Returns Promise<any>
- Defined in packages/cormo/src/query.ts:885

`Private` _getAdapterDeleteOptions

_getAdapterDeleteOptions(): AdapterDeleteOptions
Returns AdapterDeleteOptions
- Defined in packages/cormo/src/query.ts:857

`Private` _getAdapterFindOptions

_getAdapterFindOptions(): AdapterFindOptions
Returns AdapterFindOptions
- Defined in packages/cormo/src/query.ts:743

`Private` _setUsed

_setUsed(): void
Returns void
- Defined in packages/cormo/src/query.ts:996

`Private` _validateAndBuildSaveData

_validateAndBuildSaveData(errors, data, updates, path, object): void
Parameters
- errors: any
- data: any
- updates: any
- path: any
- object: any
Returns void
- Defined in packages/cormo/src/query.ts:910

cache

cache(options): Query<M, T>
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 Query<M, T>
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:604

delete

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

distinct

distinct(): Query<M, T>
Returns distinct records

Returns Query<M, T>
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
- Optional options: {
  skip_log?: boolean;
  }
  - Optional skip_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[]
- Optional fields: 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[]
- Optional fields: object
Returns QueryArray<M, U>
Implementation of QueryArray.group
- Defined in packages/cormo/src/query.ts:344

if

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

include

include(column, select?): Query<M, T>
Returns associated objects also
Parameters
- column: string
- Optional select: string
Returns Query<M, T>
Implementation of QueryArray.include
- Defined in packages/cormo/src/query.ts:502

index_hint

index_hint(hint): Query<M, T>
Parameters
- hint: string
Returns Query<M, T>
Implementation of QueryArray.index_hint
- Defined in packages/cormo/src/query.ts:520

join

join(model_class, options?): Query<M, T>
(inner) join
Parameters
- model_class: typeof BaseModel
- Optional options: {
      alias?: string;
      base_column?: string;
      join_column?: string;
  }
  - Optional alias?: string
  - Optional base_column?: string
  - Optional join_column?: string
Returns Query<M, T>
Implementation of QueryArray.join
- Defined in packages/cormo/src/query.ts:363

lean

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

left_outer_join

left_outer_join(model_class, options?): Query<M, T>
left outer join
Parameters
- model_class: typeof BaseModel
- Optional options: {
      alias?: string;
      base_column?: string;
      join_column?: string;
  }
  - Optional alias?: string
  - Optional base_column?: string
  - Optional join_column?: string
Returns Query<M, T>
Implementation of QueryArray.left_outer_join
- Defined in packages/cormo/src/query.ts:383

limit

limit(limit): Query<M, T>
Sets limit of query
Parameters
- limit: number
Returns Query<M, T>
Implementation of QueryArray.limit
- Defined in packages/cormo/src/query.ts:428

near

near(target): Query<M, T>
Finds records near target
Parameters
- target: object
Returns Query<M, T>
Implementation of QueryArray.near
- Defined in packages/cormo/src/query.ts:268

one

one(): Query<M, T>
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 Query<M, T>
Implementation of QueryArray.one
- Defined in packages/cormo/src/query.ts:416

order

order(orders?): Query<M, T>
Specifies orders of result
Parameters
- Optional orders: string
Returns Query<M, T>
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
- Optional columns: 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
- Optional columns: 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): Query<M, T>
Sets skip of query
Parameters
- skip: number
Returns Query<M, T>
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
- Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>) | ((value) => TResult1 | PromiseLike<TResult1>)
- Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)
Returns PromiseLike<TResult1 | TResult2>
Implementation of QueryArray.then
- Defined in packages/cormo/src/query.ts:585

transaction

transaction(transaction?): Query<M, T>
Parameters
- Optional transaction: Transaction
Returns Query<M, T>
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:618

upsert

upsert(updates, options?): Promise<void>
Executes the query as an insert or update operation
Parameters
- updates: any
- Optional options: {
  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:639

using

using(node): Query<M, T>
Parameters
- node: "master" | "read"
Returns Query<M, T>
Implementation of QueryArray.using
- Defined in packages/cormo/src/query.ts:515

where

where(condition?): Query<M, T>
Finds records by condition
Parameters
- Optional condition: object
Returns Query<M, T>
Implementation of QueryArray.where
- Defined in packages/cormo/src/query.ts:279

Class Query<M, T>

Type Parameters

M extends BaseModel

T = M

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

M extends BaseModel

T = M

Parameters

model: typeof BaseModel

Returns Query<M, T>

Properties

Private _adapter

Private _conditions

Private _connection

Private _current_if

Private _find_single_id

Private _id

Private _ifs

Private _includes

Type declaration

column: string

Optional select?: string

Private _model

Private _name

Private _options

Private Optional _preserve_order_ids

Private _used

Methods

Private _addCondition

Parameters

condition: any

Returns void

Private _doArchiveAndIntegrity

Parameters

options: any

Returns Promise<void>

Private _doIntegrityActions

Parameters

integrities: any

ids: any

Returns Promise<void>

Private _exec

Parameters

find_options: AdapterFindOptions

Optional options: { skip_log?: boolean; }

Optional skip_log?: boolean

Returns Promise<any>

Private _execAndInclude

Parameters

Optional options: { skip_log?: boolean; }

Optional skip_log?: boolean

Returns Promise<any>

Private _getAdapterDeleteOptions

Returns AdapterDeleteOptions

Private _getAdapterFindOptions

Returns AdapterFindOptions

Private _setUsed

Returns void

Private _validateAndBuildSaveData

Parameters

errors: any

data: any

updates: any

path: any

object: any

Returns void

cache

Parameters

options: undefined | { key: string; refresh?: boolean; ttl: number; }

Returns Query<M, T>

clone

Returns Query<M, T>

count

`Private` _adapter

`Private` _conditions

`Private` _connection

`Private` _current_if

`Private` _find_single_id

`Private` _id

`Private` _ifs

`Private` _includes

`Optional` select?: string

`Private` _model

`Private` _name

`Private` _options

`Private` `Optional` _preserve_order_ids

`Private` _used

`Private` _addCondition

`Private` _doArchiveAndIntegrity

`Private` _doIntegrityActions

`Private` _exec

`Optional` options: {
skip_log?: boolean;
}

`Optional` skip_log?: boolean

`Private` _execAndInclude

`Optional` options: {
skip_log?: boolean;
}

`Optional` skip_log?: boolean

`Private` _getAdapterDeleteOptions

`Private` _getAdapterFindOptions

`Private` _setUsed

`Private` _validateAndBuildSaveData

options: undefined | {
key: string;
refresh?: boolean;
ttl: number;
}

`Optional` options: any

`Optional` options: {
skip_log?: boolean;
}

`Optional` skip_log?: boolean

`Optional` fields: object

`Optional` fields: object

`Optional` select: string

`Optional` options: {
alias?: string;
base_column?: string;
join_column?: string;
}

`Optional` alias?: string

`Optional` base_column?: string

`Optional` join_column?: string