Class

FromClause

FromClause(clauseopt)

Constructor

# new FromClause(clauseopt)

The FROM clause

Parameters:
Name Type Attributes Description
clause ModelArg <optional>
Implements:

View Source query/clauses/FromClause.ts, line 6

Extends

Members

# protected selector

Stores the selector

Properties:
Name Type Description
selector
Overrides:

View Source query/clauses/SelectorBasedClause.ts, line 29

Methods

# build() → {Q}

Method to build and validate the prepared statement before the execution;

.

Method to build and validate the prepared statement before the execution;

Inherited From:
Implements:

View Source query/options.ts, line 21

for invalid statements

QueryError
Q

# execute(args) → {Promise.<V>}

Processes itself

Parameters:
Name Type Description
args Array.<any>
Inherited From:
Implements:

View Source interfaces/Executor.ts, line 14

Promise.<V>

# getPriority()

return the priority of the clause

Overrides:
See:

View Source query/Clause.ts, line 50

# groupBy(selector) → {Executor}

Groups records by an attribute

Parameters:
Name Type Description
selector GroupBySelector
Inherited From:
Implements:

View Source query/options.ts, line 40

Executor

# limit(selector) → {OffsetOption}

Limits the results to the provided number

Parameters:
Name Type Description
selector LimitSelector
Inherited From:
Implements:

View Source query/options.ts, line 78

OffsetOption

# offset(selector) → {Executor}

Offsets the results by the provided selector

Parameters:
Name Type Description
selector OffsetSelector
Inherited From:
Implements:

View Source query/options.ts, line 59

Executor

# orderBy(selector) → {LimitOption|OffsetOption}

Orders the results by the provided attribute and according to the provided direction

Parameters:
Name Type Description
selector OrderBySelector
Inherited From:
Implements:

View Source query/options.ts, line 97

# async paginate(size) → {Promise.<Paginator.<R, Q>>}

Parameters:
Name Type Description
size number
Inherited From:

View Source query/Clause.ts, line 111

Promise.<Paginator.<R, Q>>

# where(condition) → {OrderAndGroupOption}

filter the records by a condition

Parameters:
Name Type Description
condition Condition
Implements:

View Source query/options.ts, line 129

FromClause(clauseopt)

Constructor

# new FromClause(clauseopt)

The INSERT/INTO clause

Parameters:
Name Type Attributes Description
clause ClauseArg <optional>
Implements:

View Source query/clauses/InsertClause.ts, line 11

Extends

Members

# protected selector

Stores the selector

Properties:
Name Type Description
selector
Overrides:

View Source query/clauses/SelectorBasedClause.ts, line 29

Methods

# build() → {Q}

Method to build and validate the prepared statement before the execution;

.

Method to build and validate the prepared statement before the execution;

Inherited From:
Implements:

View Source query/options.ts, line 21

for invalid statements

QueryError
Q

# execute(args) → {Promise.<V>}

Processes itself

Parameters:
Name Type Description
args Array.<any>
Inherited From:
Implements:

View Source interfaces/Executor.ts, line 14

Promise.<V>

# getPriority()

return the priority of the clause

Overrides:
See:

View Source query/Clause.ts, line 50

# groupBy(selector) → {Executor}

Groups records by an attribute

Parameters:
Name Type Description
selector GroupBySelector
Inherited From:
Implements:

View Source query/options.ts, line 40

Executor

# limit(selector) → {OffsetOption}

Limits the results to the provided number

Parameters:
Name Type Description
selector LimitSelector
Inherited From:
Implements:

View Source query/options.ts, line 78

OffsetOption

# offset(selector) → {Executor}

Offsets the results by the provided selector

Parameters:
Name Type Description
selector OffsetSelector
Inherited From:
Implements:

View Source query/options.ts, line 59

Executor

# orderBy(selector) → {LimitOption|OffsetOption}

Orders the results by the provided attribute and according to the provided direction

Parameters:
Name Type Description
selector OrderBySelector
Inherited From:
Implements:

View Source query/options.ts, line 97

# async paginate(size) → {Promise.<Paginator.<R, Q>>}

Parameters:
Name Type Description
size number
Inherited From:

View Source query/Clause.ts, line 111

Promise.<Paginator.<R, Q>>

# where(condition) → {OrderAndGroupOption}

filter the records by a condition

Parameters:
Name Type Description
condition Condition
Implements:

View Source query/options.ts, line 129

FromClause(clauseopt)

Constructor

# new FromClause(clauseopt)

The OFFSET clause

Parameters:
Name Type Attributes Description
clause ClauseArg <optional>

View Source query/clauses/OffsetClause.ts, line 4

Extends

Members

# protected selector

Stores the selector

Properties:
Name Type Description
selector
Overrides:

View Source query/clauses/SelectorBasedClause.ts, line 29

Methods

# build() → {Q}

Method to build and validate the prepared statement before the execution;

.

Method to build and validate the prepared statement before the execution;

Inherited From:
Implements:

View Source query/options.ts, line 21

for invalid statements

QueryError
Q

# execute(args) → {Promise.<V>}

Processes itself

Parameters:
Name Type Description
args Array.<any>
Inherited From:
Implements:

View Source interfaces/Executor.ts, line 14

Promise.<V>

# getPriority()

return the priority of the clause

Overrides:
See:

View Source query/Clause.ts, line 50

# groupBy(selector) → {Executor}

Groups records by an attribute

Parameters:
Name Type Description
selector GroupBySelector
Inherited From:
Implements:

View Source query/options.ts, line 40

Executor

# limit(selector) → {OffsetOption}

Limits the results to the provided number

Parameters:
Name Type Description
selector LimitSelector
Inherited From:
Implements:

View Source query/options.ts, line 78

OffsetOption

# offset(selector) → {Executor}

Offsets the results by the provided selector

Parameters:
Name Type Description
selector OffsetSelector
Inherited From:
Implements:

View Source query/options.ts, line 59

Executor

# orderBy(selector) → {LimitOption|OffsetOption}

Orders the results by the provided attribute and according to the provided direction

Parameters:
Name Type Description
selector OrderBySelector
Inherited From:
Implements:

View Source query/options.ts, line 97

# async paginate(size) → {Promise.<Paginator.<R, Q>>}

Parameters:
Name Type Description
size number
Inherited From:

View Source query/Clause.ts, line 111

Promise.<Paginator.<R, Q>>

# where(condition) → {OrderAndGroupOption}

filter the records by a condition

Parameters:
Name Type Description
condition Condition
Implements:

View Source query/options.ts, line 129