Query | @cashfarm/store

Type parameters

TTable: Table

Hierarchy

Whereable<TTable, Query<TTable>>
- Query

Implements

IQuery<TTable>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Query(table: TTable): Query

Overrides CriteriaEnabled.constructor
- Defined in dialects/mysql/query.ts:43
Parameters
- table: TTable
Returns Query

Properties

$table

$table: TTable

_groupBy

_groupBy: Field[]

_limit

_limit: number

_offset

_offset: number

_orderBy

_orderBy: IOrderByCriteria[]

_select

_select: Set<Field>

conditions

conditions: ConditionGroup

Accessors

GroupBy

GroupBy:

Limit

Limit:

Offset

Offset:

OrderBy

OrderBy:

Select

Select:

Methods

buildGroupCondition

buildGroupCondition(gp: ConditionGroup): string

Inherited from Whereable.buildGroupCondition
- Defined in dialects/mysql/whereable.ts:11
Parameters
- gp: ConditionGroup
Returns string

buildWhere

buildWhere(): string

Inherited from Whereable.buildWhere
- Defined in dialects/mysql/whereable.ts:27
Returns string

clearGroupBy

clearGroupBy(): Query<TTable>

Implementation of IQuery.clearGroupBy
- Defined in dialects/mysql/query.ts:190
Clears the list of grouping fields

memberof

Query

Returns Query<TTable>

clearLimit

clearLimit(): Query<TTable>

Implementation of IQuery.clearLimit
- Defined in dialects/mysql/query.ts:202
Clears the limit option

memberof

Query

Returns Query<TTable>

clearOffset

clearOffset(): Query<TTable>

Implementation of IQuery.clearOffset
- Defined in dialects/mysql/query.ts:214
Clears the offset option

memberof

Query

Returns Query<TTable>

clearOrderBy

clearOrderBy(): Query<TTable>

Implementation of IQuery.clearOrderBy
- Defined in dialects/mysql/query.ts:178
Clears the list of ordering fields

memberof

Query

Returns Query<TTable>

clearSelect

clearSelect(): Query<TTable>

Implementation of IQuery.clearSelect
- Defined in dialects/mysql/query.ts:166
Clears the list of ordering fields

memberof

Query

Returns Query<TTable>

groupBy

groupBy(fields: FieldOrSelector<TTable>[]): Query<TTable>
groupBy(field: FieldOrSelector<TTable>, ...fields: FieldOrSelector<TTable>[]): Query<TTable>

Implementation of IQuery.groupBy
- Defined in dialects/mysql/query.ts:110
Sets the list of grouping fields.

memberof

Query

Parameters
- fields: FieldOrSelector<TTable>[]
Returns Query<TTable>
- Defined in dialects/mysql/query.ts:111
Parameters
- field: FieldOrSelector<TTable>
- Rest ...fields: FieldOrSelector<TTable>[]
Returns Query<TTable>

limit

limit(limit: number): this

Implementation of IQuery.limit
- Defined in dialects/mysql/query.ts:141
Sets the limit of items returned

memberof

Query

Parameters
- limit: number
Returns this

offset

offset(offset: number): this

Implementation of IQuery.offset
- Defined in dialects/mysql/query.ts:154
Sets the index of the first item to be returned

memberof

Query

Parameters
- offset: number
Returns this

orderBy

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

Implementation of IQuery.orderBy
- Defined in dialects/mysql/query.ts:77
Appends field to the list of ordering fields.

memberof

Query

Parameters
- field: FieldOrSelector<TTable>
- direction: OrderDirection
Returns Query<TTable>
Implementation of IQuery.orderBy
- Defined in dialects/mysql/query.ts:78
Parameters
- field: [FieldOrSelector<TTable>, OrderDirection]
- Rest ...otherFields: Array<[FieldOrSelector<TTable>, OrderDirection]>
Returns Query<TTable>

select

select(fieldListSelector: function): Query<TTable>

- Defined in dialects/mysql/query.ts:57
Defines the set of fields that will be selected from the table.

memberof

Criteria

Parameters
- fieldListSelector: function
  - - (table: TTable): Field[]
    - Parameters
      - table: TTable
      Returns Field[]
Returns Query<TTable>

toString

toString(): string

Implementation of IQuery.toString
- Defined in dialects/mysql/query.ts:219
Returns string

where

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

Implementation of IQuery.where

Inherited from CriteriaEnabled.where

Overrides Criteria.where
- Defined in criteria.ts:217
Parameters
- condition: ConditionBuilder<TTable>
Returns Query<TTable>
Implementation of IQuery.where

Inherited from CriteriaEnabled.where

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

Inherited from CriteriaEnabled.where

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

whereAll

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

Implementation of IQuery.whereAll

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 Query<TTable>
Implementation of IQuery.whereAll

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 Query<TTable>

whereAny

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

Implementation of IQuery.whereAny

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 Query<TTable>
Implementation of IQuery.whereAny

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 Query<TTable>

Generated using TypeDoc

Type parameters

TTable: Table

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

table: TTable

Returns Query

Properties

$table

_groupBy

_limit

_offset

_orderBy

_select

conditions

Accessors

GroupBy

Limit

Offset

OrderBy

Select

Methods

buildGroupCondition

Parameters

gp: ConditionGroup

Returns string

buildWhere

Returns string

clearGroupBy

Returns Query<TTable>

clearLimit

Returns Query<TTable>

clearOffset

Returns Query<TTable>

clearOrderBy

Returns Query<TTable>

clearSelect

Returns Query<TTable>

groupBy

Parameters

fields: FieldOrSelector<TTable>[]

Returns Query<TTable>

Parameters

field: FieldOrSelector<TTable>

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

Returns Query<TTable>

limit

Parameters

limit: number

Returns this

offset

Parameters

offset: number

Returns this

orderBy

Parameters

field: FieldOrSelector<TTable>

direction: OrderDirection

Returns Query<TTable>

Parameters

field: [FieldOrSelector<TTable>, OrderDirection]

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

Returns Query<TTable>

select

Parameters

fieldListSelector: function

Parameters

table: TTable

Returns Field[]

Returns Query<TTable>

toString

Returns string

where