Class Comment

Hierarchy

Node
- Comment

Index

Constructors

Properties

Methods

and coalesce createAnd createFalse createJoin createOn createStringJoin createTableAlias createTrue grouping lower not or toSQL

Constructors

constructor

new Comment(values): Comment
Parameters
- values: any[]
Returns Comment
Overrides Node.constructor
- Defined in src/nodes/Comment.ts:6

Properties

`Readonly` values

values: any[]

Methods

and

and(right): And
Parameters
- right: any
Returns And
Inherited from Node.and
- Defined in src/mixins/NodeMethods.ts:11

coalesce

coalesce(...exprs): NamedSQLFunction
Parameters
- Rest ...exprs: any[]
Returns NamedSQLFunction
Inherited from Node.coalesce
- Defined in src/mixins/FactoryMethods.ts:22

createAnd

createAnd(clauses): And
Parameters
- clauses: any[]
Returns And
Inherited from Node.createAnd
- Defined in src/mixins/FactoryMethods.ts:26

createFalse

createFalse(): False
Returns False
Inherited from Node.createFalse
- Defined in src/mixins/FactoryMethods.ts:30

createJoin

createJoin(to): InnerJoin
Parameters
- to: null | string | SQLLiteral | Relation
Returns InnerJoin
Inherited from Node.createJoin
- Defined in src/mixins/FactoryMethods.ts:34
createJoin(to, constraint): InnerJoin
Parameters
- to: null | string | SQLLiteral | Relation
- constraint: any
Returns InnerJoin
Inherited from Node.createJoin
- Defined in src/mixins/FactoryMethods.ts:35
createJoin(to, constraint, Klass): FullOuterJoin
Parameters
- to: null | string | SQLLiteral | Relation
- constraint: any
- Klass: typeof FullOuterJoin
Returns FullOuterJoin
Inherited from Node.createJoin
- Defined in src/mixins/FactoryMethods.ts:39
createJoin(to, constraint, Klass): InnerJoin
Parameters
- to: null | string | SQLLiteral | Relation
- constraint: any
- Klass: typeof InnerJoin
Returns InnerJoin
Inherited from Node.createJoin
- Defined in src/mixins/FactoryMethods.ts:44
createJoin(to, constraint, Klass): OuterJoin
Parameters
- to: null | string | SQLLiteral | Relation
- constraint: any
- Klass: typeof OuterJoin
Returns OuterJoin
Inherited from Node.createJoin
- Defined in src/mixins/FactoryMethods.ts:49
createJoin(to, constraint, Klass): RightOuterJoin
Parameters
- to: null | string | SQLLiteral | Relation
- constraint: any
- Klass: typeof RightOuterJoin
Returns RightOuterJoin
Inherited from Node.createJoin
- Defined in src/mixins/FactoryMethods.ts:54
createJoin(to, constraint, Klass): StringJoin
Parameters
- to: null | string | SQLLiteral | Relation
- constraint: any
- Klass: typeof StringJoin
Returns StringJoin
Inherited from Node.createJoin
- Defined in src/mixins/FactoryMethods.ts:59

createOn

createOn(expr): On
Parameters
- expr: any
Returns On
Inherited from Node.createOn
- Defined in src/mixins/FactoryMethods.ts:72

createStringJoin

createStringJoin(to): StringJoin
Parameters
- to: null | string | SQLLiteral | Relation
Returns StringJoin
Inherited from Node.createStringJoin
- Defined in src/mixins/FactoryMethods.ts:76

createTableAlias

createTableAlias(relation, name): TableAlias
Parameters
- relation: Relation | Grouping
- name: string | SQLLiteral
Returns TableAlias
Inherited from Node.createTableAlias
- Defined in src/mixins/FactoryMethods.ts:80

createTrue

createTrue(): True
Returns True
Inherited from Node.createTrue
- Defined in src/mixins/FactoryMethods.ts:87

grouping

grouping(expr): Grouping
Parameters
- expr: any
Returns Grouping
Inherited from Node.grouping
- Defined in src/mixins/FactoryMethods.ts:91

lower

lower(column): NamedSQLFunction
Parameters
- column: any
Returns NamedSQLFunction
Inherited from Node.lower
- Defined in src/mixins/FactoryMethods.ts:95

not

not(this): Not
Parameters
- this: Node
Returns Not
Inherited from Node.not
- Defined in src/mixins/NodeMethods.ts:15

or

or<T>(right): Grouping
Type Parameters
- T extends Visitable
Parameters
- right: T
Returns Grouping
Inherited from Node.or
- Defined in src/mixins/NodeMethods.ts:19

toSQL

toSQL(engine?): any
Parameters
- engine: undefined | null | Engine = undefined
Returns any
Inherited from Node.toSQL
- Defined in src/nodes/Node.ts:16

Class Comment

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

values: any[]

Returns Comment

Properties

Readonly values

Methods

and

Parameters

right: any

Returns And

coalesce

Parameters

Rest ...exprs: any[]

Returns NamedSQLFunction

createAnd

Parameters

clauses: any[]

Returns And

createFalse

Returns False

createJoin

Parameters

to: null | string | SQLLiteral | Relation

Returns InnerJoin

Parameters

to: null | string | SQLLiteral | Relation

constraint: any

Returns InnerJoin

Parameters

to: null | string | SQLLiteral | Relation

constraint: any

Klass: typeof FullOuterJoin

Returns FullOuterJoin

Parameters

to: null | string | SQLLiteral | Relation

constraint: any

Klass: typeof InnerJoin

Returns InnerJoin

Parameters

to: null | string | SQLLiteral | Relation

constraint: any

Klass: typeof OuterJoin

Returns OuterJoin

Parameters

to: null | string | SQLLiteral | Relation

constraint: any

Klass: typeof RightOuterJoin

Returns RightOuterJoin

Parameters

to: null | string | SQLLiteral | Relation

constraint: any

Klass: typeof StringJoin

Returns StringJoin

createOn

Parameters

expr: any

Returns On

createStringJoin

Parameters

to: null | string | SQLLiteral | Relation

Returns StringJoin

createTableAlias

Parameters

relation: Relation | Grouping

name: string | SQLLiteral

Returns TableAlias

createTrue

Returns True

grouping

Parameters

expr: any

Returns Grouping

`Readonly` values

`Rest` ...exprs: any[]