Interface QueryArray<M, T>

Type parameters

M: BaseModel
T = M

Hierarchy

PromiseLike<T[]>
- QueryArray

Implemented by

Query

Methods

cache

cache(options: undefined | { key: string; refresh?: boolean; ttl: number }): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:167
Parameters
- options: undefined | { key: string; refresh?: boolean; ttl: number }
Returns QueryArray<M, T>

clone

clone(): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:136
Returns QueryArray<M, T>

count

count(): PromiseLike<number>

- Defined in packages/cormo/src/query.ts:176
Returns PromiseLike<number>

delete

delete(options?: any): PromiseLike<number>

- Defined in packages/cormo/src/query.ts:179
Parameters
- Optional options: any
Returns PromiseLike<number>

distinct

distinct(): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:160
Returns QueryArray<M, T>

endif

endif(): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:166
Returns QueryArray<M, T>

exec

exec(options?: { skip_log?: boolean }): PromiseLike<T[]>

- Defined in packages/cormo/src/query.ts:173
Parameters
- Optional options: { skip_log?: boolean }
  - Optional skip_log?: boolean
Returns PromiseLike<T[]>

explain

explain(): PromiseLike<any>

- Defined in packages/cormo/src/query.ts:175
Returns PromiseLike<any>

find

find(id: types.RecordID): QuerySingle<M, T>
find(id: types.RecordID[]): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:137
Parameters
- id: types.RecordID
Returns QuerySingle<M, T>
- Defined in packages/cormo/src/query.ts:138
Parameters
- id: types.RecordID[]
Returns QueryArray<M, T>

findPreserve

findPreserve(id: types.RecordID[]): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:139
Parameters
- id: types.RecordID[]
Returns QueryArray<M, T>

group

group<G, F>(group_by: G | G[], fields?: F): QueryArray<M, { [ field in string | number | symbol]: number } & Pick<M, G>>
group<F>(group_by: null, fields?: F): QueryArray<M, { [ field in string | number | symbol]: number }>
group<U>(group_by: null | string, fields?: object): QueryArray<M, U>

- Defined in packages/cormo/src/query.ts:146
Type parameters
- G: string | number | symbol
- F
Parameters
- group_by: G | G[]
- Optional fields: F
Returns QueryArray<M, { [ field in string | number | symbol]: number } & Pick<M, G>>
- Defined in packages/cormo/src/query.ts:150
Type parameters
- F
Parameters
- group_by: null
- Optional fields: F
Returns QueryArray<M, { [ field in string | number | symbol]: number }>
- Defined in packages/cormo/src/query.ts:151
Type parameters
- U
Parameters
- group_by: null | string
- Optional fields: object
Returns QueryArray<M, U>

if

if(condition: boolean): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:165
Parameters
- condition: boolean
Returns QueryArray<M, T>

include

include(column: string, select?: string): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:168
Parameters
- column: string
- Optional select: string
Returns QueryArray<M, T>

index_hint

index_hint(hint: string): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:171
Parameters
- hint: string
Returns QueryArray<M, T>

join

join(model: typeof BaseModel, options?: { alias?: string; base_column?: string; join_column?: string }): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:152
Parameters
- model: typeof BaseModel
- Optional options: { alias?: string; base_column?: string; join_column?: string }
  - Optional alias?: string
  - Optional base_column?: string
  - Optional join_column?: string
Returns QueryArray<M, T>

lean

lean(lean?: boolean): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:164
Parameters
- Optional lean: boolean
Returns QueryArray<M, T>

left_outer_join

left_outer_join(model: typeof BaseModel, options?: { alias?: string; base_column?: string; join_column?: string }): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:156
Parameters
- model: typeof BaseModel
- Optional options: { alias?: string; base_column?: string; join_column?: string }
  - Optional alias?: string
  - Optional base_column?: string
  - Optional join_column?: string
Returns QueryArray<M, T>

limit

limit(limit?: number): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:162
Parameters
- Optional limit: number
Returns QueryArray<M, T>

near

near(target: object): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:140
Parameters
- target: object
Returns QueryArray<M, T>

one

one(): QuerySingleNull<M, T>

- Defined in packages/cormo/src/query.ts:161
Returns QuerySingleNull<M, T>

order

order(orders?: string): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:145
Parameters
- Optional orders: string
Returns QueryArray<M, T>

select

select<K>(columns: K[]): QueryArray<M, Pick<M, K>>
select<K>(columns?: string): QueryArray<M, Pick<M, K>>

- Defined in packages/cormo/src/query.ts:142
Type parameters
- K: string | number | symbol
Parameters
- columns: K[]
Returns QueryArray<M, Pick<M, K>>
- Defined in packages/cormo/src/query.ts:143
Type parameters
- K: string | number | symbol
Parameters
- Optional columns: string
Returns QueryArray<M, Pick<M, K>>

selectSingle

selectSingle<K>(column: K): QueryArray<M, M[K]>

- Defined in packages/cormo/src/query.ts:144
Type parameters
- K: string | number | symbol
Parameters
- column: K
Returns QueryArray<M, M[K]>

skip

skip(skip?: number): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:163
Parameters
- Optional skip: number
Returns QueryArray<M, T>

stream

stream(): Readable

- Defined in packages/cormo/src/query.ts:174
Returns Readable

then

then<TResult1, TResult2>(onfulfilled?: null | ((value: T[]) => TResult1 | PromiseLike<TResult1>), onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)): PromiseLike<TResult1 | TResult2>

Inherited from PromiseLike.then
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1489
Attaches callbacks for the resolution and/or rejection of the Promise.

Type parameters
- TResult1 = T[]
- TResult2 = never
Parameters
- Optional onfulfilled: null | ((value: T[]) => TResult1 | PromiseLike<TResult1>)
  
  The callback to execute when the Promise is resolved.
- Optional onrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)
  
  The callback to execute when the Promise is rejected.
Returns PromiseLike<TResult1 | TResult2>
A Promise for the completion of which ever callback is executed.

transaction

transaction(transaction?: Transaction): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:169
Parameters
- Optional transaction: Transaction
Returns QueryArray<M, T>

update

update(updates: object): PromiseLike<number>

- Defined in packages/cormo/src/query.ts:177
Parameters
- updates: object
Returns PromiseLike<number>

upsert

upsert(updates: object, options?: { ignore_on_update: string[] }): PromiseLike<void>

- Defined in packages/cormo/src/query.ts:178
Parameters
- updates: object
- Optional options: { ignore_on_update: string[] }
  - ignore_on_update: string[]
Returns PromiseLike<void>

using

using(node: "master" | "read"): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:170
Parameters
- node: "master" | "read"
Returns QueryArray<M, T>

where

where(condition?: object): QueryArray<M, T>

- Defined in packages/cormo/src/query.ts:141
Parameters
- Optional condition: object
Returns QueryArray<M, T>

Generated using TypeDoc