IQuery | @cashfarm/store

Type parameters

TTable: Table

Hierarchy

CriteriaEnabled<TTable, IQuery<TTable>>
- IQuery

Implemented by

Query

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IQuery(table: TTable): IQuery

Inherited from CriteriaEnabled.constructor

Overrides Criteria.constructor
- Defined in criteria.ts:211
Parameters
- table: TTable
Returns IQuery

Properties

$table

$table: TTable

conditions

conditions: ConditionGroup

Methods

clearGroupBy

clearGroupBy(): IQuery<TTable>

- Defined in dialects/iQuery.ts:89
Clears the list of grouping fields

memberof

Query

Returns IQuery<TTable>

clearLimit

clearLimit(): IQuery<TTable>

- Defined in dialects/iQuery.ts:98
Clears the limit option

memberof

Query

Returns IQuery<TTable>

clearOffset

clearOffset(): IQuery<TTable>

- Defined in dialects/iQuery.ts:107
Clears the offset option

memberof

Query

Returns IQuery<TTable>

clearOrderBy

clearOrderBy(): IQuery<TTable>

- Defined in dialects/iQuery.ts:80
Clears the list of ordering fields

memberof

Query

Returns IQuery<TTable>

clearSelect

clearSelect(): IQuery<TTable>

- Defined in dialects/iQuery.ts:71
Clears the list of ordering fields

memberof

Query

Returns IQuery<TTable>

groupBy

groupBy(fields: FieldOrSelector<TTable>[]): IQuery<TTable>
groupBy(...fields: FieldOrSelector<TTable>[]): IQuery<TTable>

- Defined in dialects/iQuery.ts:41
Sets the list of grouping fields.

memberof

Query

Parameters
- fields: FieldOrSelector<TTable>[]
Returns IQuery<TTable>
- Defined in dialects/iQuery.ts:42
Parameters
- Rest ...fields: FieldOrSelector<TTable>[]
Returns IQuery<TTable>

limit

limit(limit: number): IQuery<TTable>

- Defined in dialects/iQuery.ts:52
Sets the limit of items returned

memberof

Query

Parameters
- limit: number
Returns IQuery<TTable>

offset

offset(offset: number): IQuery<TTable>

- Defined in dialects/iQuery.ts:62
Sets the index of the first item to be returned

memberof

Query

Parameters
- offset: number
Returns IQuery<TTable>

orderBy

orderBy(field: FieldOrSelector<TTable>, direction: OrderDirection): IQuery<TTable>
orderBy(field: [FieldOrSelector<TTable>, OrderDirection], ...otherFields: Array<[FieldOrSelector<TTable>, OrderDirection]>): IQuery<TTable>

- Defined in dialects/iQuery.ts:28
Appends field to the list of ordering fields.

memberof

Query

Parameters
- field: FieldOrSelector<TTable>
- direction: OrderDirection
Returns IQuery<TTable>
- Defined in dialects/iQuery.ts:29
Parameters
- field: [FieldOrSelector<TTable>, OrderDirection]
- Rest ...otherFields: Array<[FieldOrSelector<TTable>, OrderDirection]>
Returns IQuery<TTable>

select

select(fieldListSelector: function): IQuery<TTable>

- Defined in dialects/iQuery.ts:17
Defines the set of fields that will be selected from the table.

memberof

Criteria

Parameters
- fieldListSelector: function
  - - (table: TTable): IField[]
    - Parameters
      - table: TTable
      Returns IField[]
Returns IQuery<TTable>

toString

toString(): string

- Defined in dialects/iQuery.ts:109
Returns string

where

where(condition: ConditionBuilder<TTable>): IQuery<TTable>
where(field: string | FieldSelector<TTable>, value: number | number[] | string | string[]): IQuery<TTable>
where(field: string | FieldSelector<TTable>, operator: string, value: any): IQuery<TTable>

Inherited from CriteriaEnabled.where

Overrides Criteria.where
- Defined in criteria.ts:217
Parameters
- condition: ConditionBuilder<TTable>
Returns IQuery<TTable>
Inherited from CriteriaEnabled.where

Overrides Criteria.where
- Defined in criteria.ts:218
Parameters
- field: string | FieldSelector<TTable>
- value: number | number[] | string | string[]
Returns IQuery<TTable>
Inherited from CriteriaEnabled.where

Overrides Criteria.where
- Defined in criteria.ts:219
Parameters
- field: string | FieldSelector<TTable>
- operator: string
- value: any
Returns IQuery<TTable>

whereAll

whereAll(condition: IConditionsMap | Array<ConditionBuilder<TTable>>): IQuery<TTable>
whereAll(condition: ConditionBuilder<TTable>, ...conditions: ConditionBuilder<TTable>[]): IQuery<TTable>

Inherited from CriteriaEnabled.whereAll

Overrides Criteria.whereAll
- Defined in criteria.ts:260
Adds a group of conditions connect by an AND operator

memberof

Criteria

Parameters
- condition: IConditionsMap | Array<ConditionBuilder<TTable>>
Returns IQuery<TTable>
Inherited from CriteriaEnabled.whereAll

Overrides Criteria.whereAll
- Defined in criteria.ts:270
Adds a group of conditions connect by an AND operator

memberof

Criteria

Parameters
- condition: ConditionBuilder<TTable>
- Rest ...conditions: ConditionBuilder<TTable>[]
Returns IQuery<TTable>

whereAny

whereAny(condition: IConditionsMap | Array<ConditionBuilder<TTable>>): IQuery<TTable>
whereAny(condition: ConditionBuilder<TTable>, ...conditions: ConditionBuilder<TTable>[]): IQuery<TTable>

Inherited from CriteriaEnabled.whereAny

Overrides Criteria.whereAny
- Defined in criteria.ts:235
Adds a group of conditions connect by an OR operator

memberof

Criteria

Parameters
- condition: IConditionsMap | Array<ConditionBuilder<TTable>>
Returns IQuery<TTable>
Inherited from CriteriaEnabled.whereAny

Overrides Criteria.whereAny
- Defined in criteria.ts:245
Adds a group of conditions connect by an OR operator

memberof

Criteria

Parameters
- condition: ConditionBuilder<TTable>
- Rest ...conditions: ConditionBuilder<TTable>[]
Returns IQuery<TTable>

Generated using TypeDoc

Type parameters

TTable: Table

Hierarchy

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

table: TTable

Returns IQuery

Properties

$table

conditions

Methods

clearGroupBy

Returns IQuery<TTable>

clearLimit

Returns IQuery<TTable>

clearOffset

Returns IQuery<TTable>

clearOrderBy

Returns IQuery<TTable>

clearSelect

Returns IQuery<TTable>

groupBy

Parameters

fields: FieldOrSelector<TTable>[]

Returns IQuery<TTable>

Parameters

Rest ...fields: FieldOrSelector<TTable>[]

Returns IQuery<TTable>

limit

Parameters

limit: number

Returns IQuery<TTable>

offset

Parameters

offset: number

Returns IQuery<TTable>

orderBy

Parameters

field: FieldOrSelector<TTable>

direction: OrderDirection

Returns IQuery<TTable>

Parameters

field: [FieldOrSelector<TTable>, OrderDirection]

Rest ...otherFields: Array<[FieldOrSelector<TTable>, OrderDirection]>

Returns IQuery<TTable>

select

Parameters

fieldListSelector: function

Parameters

table: TTable

Returns IField[]

Returns IQuery<TTable>

toString

Returns string

where

Parameters

condition: ConditionBuilder<TTable>

Returns IQuery<TTable>

Parameters

field: string | FieldSelector<TTable>

value: number | number[] | string | string[]

Returns IQuery<TTable>

Parameters

field: string | FieldSelector<TTable>

operator: string

value: any

Returns IQuery<TTable>

whereAll

Parameters

condition: IConditionsMap | Array<ConditionBuilder<TTable>>

Returns IQuery<TTable>

Parameters

condition: ConditionBuilder<TTable>

Rest ...conditions: ConditionBuilder<TTable>[]