Class OptimizerHints

constructor

• new OptimizerHints(expr): OptimizerHints

• Parameters

  • expr: Visitable[]

  Returns OptimizerHints

expr

value

• get value(): T

• Returns T

add

• add(other): Grouping

• Parameters

  • other: any

  Returns Grouping

and

• and(right): And

• Parameters

  • right: any

  Returns And

as

• as(other): As

• Parameters

  • other: string | SQLLiteral

  Returns As

asc

• asc(this): Ascending

• Parameters

  • this: Visitable

  Returns Ascending

average

• average(): Avg

• Returns Avg

between

• between(begin, end, inclusive?): Between | GreaterThanOrEqual | LessThan | LessThanOrEqual | NotIn | And

• Parameters

  • begin: number | BindParam | Quoted

  • end: number | BindParam | Quoted

  • inclusive: boolean = true

  Returns Between | GreaterThanOrEqual | LessThan | LessThanOrEqual | NotIn | And

bitwiseAnd

• bitwiseAnd(other): Grouping

• Parameters

  • other: any

  Returns Grouping

bitwiseNot

• bitwiseNot(): BitwiseNot

• Returns BitwiseNot

bitwiseOr

• bitwiseOr(other): Grouping

• Parameters

  • other: any

  Returns Grouping

bitwiseShiftLeft

• bitwiseShiftLeft(other): Grouping

• Parameters

  • other: any

  Returns Grouping

bitwiseShiftRight

• bitwiseShiftRight(other): Grouping

• Parameters

  • other: any

  Returns Grouping

bitwiseXor

• bitwiseXor(other): Grouping

• Parameters

  • other: any

  Returns Grouping

coalesce

• coalesce(...exprs): NamedSQLFunction

• Parameters

  • Rest ...exprs: any[]

  Returns NamedSQLFunction

concat

• concat(other): Concat

• Parameters

  • other: any

  Returns Concat

count

• count(distinct?): Count

• Parameters

  • distinct: boolean = false

  Returns Count

createAnd

• createAnd(clauses): And

• Parameters

  • clauses: any[]

  Returns And

createFalse

• createFalse(): False

• Returns False

createJoin

• createJoin(to): InnerJoin

• Parameters

  • to: null | string | SQLLiteral | Relation

  Returns InnerJoin

• createJoin(to, constraint): InnerJoin

• Parameters

  • to: null | string | SQLLiteral | Relation

  • constraint: any

  Returns InnerJoin

• createJoin(to, constraint, Klass): FullOuterJoin

• Parameters

  • to: null | string | SQLLiteral | Relation

  • constraint: any

  • Klass: typeof FullOuterJoin

  Returns FullOuterJoin

• createJoin(to, constraint, Klass): InnerJoin

• Parameters

  • to: null | string | SQLLiteral | Relation

  • constraint: any

  • Klass: typeof InnerJoin

  Returns InnerJoin

• createJoin(to, constraint, Klass): OuterJoin

• Parameters

  • to: null | string | SQLLiteral | Relation

  • constraint: any

  • Klass: typeof OuterJoin

  Returns OuterJoin

• createJoin(to, constraint, Klass): RightOuterJoin

• Parameters

  • to: null | string | SQLLiteral | Relation

  • constraint: any

  • Klass: typeof RightOuterJoin

  Returns RightOuterJoin

• createJoin(to, constraint, Klass): StringJoin

• Parameters

  • to: null | string | SQLLiteral | Relation

  • constraint: any

  • Klass: typeof StringJoin

  Returns StringJoin

createOn

• createOn(expr): On

• Parameters

  • expr: any

  Returns On

createStringJoin

• createStringJoin(to): StringJoin

• Parameters

  • to: null | string | SQLLiteral | Relation

  Returns StringJoin

createTableAlias

• createTableAlias(relation, name): TableAlias

• Parameters

  • relation: Relation | Grouping

  • name: string | SQLLiteral

  Returns TableAlias

createTrue

• createTrue(): True

• Returns True

desc

• desc(this): Descending

• Parameters

  • this: Visitable

  Returns Descending

divide

• divide(other): Division

• Parameters

  • other: any

  Returns Division

doesNotMatch

• doesNotMatch(other, escape?, caseSensitive?): DoesNotMatch

• Parameters

  • other: any

  • escape: any = null

  • caseSensitive: boolean = false

  Returns DoesNotMatch

doesNotMatchAll

• doesNotMatchAll(others, escape?, caseSensitive?): Grouping

• Parameters

  • others: any

  • escape: any = null

  • caseSensitive: boolean = false

  Returns Grouping

doesNotMatchAny

• doesNotMatchAny(others, escape?, caseSensitive?): Grouping

• Parameters

  • others: any

  • escape: any = null

  • caseSensitive: boolean = false

  Returns Grouping

doesNotMatchRegexp

• doesNotMatchRegexp(other, caseSensitive?): NotRegexp

• Parameters

  • other: any

  • caseSensitive: boolean = true

  Returns NotRegexp

eq

• eq(other): Equality<any, any>

• Parameters

  • other: any

  Returns Equality<any, any>

eqAll

• eqAll(others): Grouping

• Parameters

  • others: any[]

  Returns Grouping

eqAny

• eqAny(others): Grouping

• Parameters

  • others: any[]

  Returns Grouping

extract

• extract(field): Extract

• Parameters

  • field: any

  Returns Extract

grouping

• grouping(expr): Grouping

• Parameters

  • expr: any

  Returns Grouping

gt

• gt(other): GreaterThan

• Parameters

  • other: any

  Returns GreaterThan

gtAll

• gtAll(others): Grouping

• Parameters

  • others: any[]

  Returns Grouping

gtAny

• gtAny(others): Grouping

• Parameters

  • others: any[]

  Returns Grouping

gteq

• gteq(other): GreaterThanOrEqual

• Parameters

  • other: any

  Returns GreaterThanOrEqual

gteqAll

• gteqAll(others): Grouping

• Parameters

  • others: any[]

  Returns Grouping

gteqAny

• gteqAny(others): Grouping

• Parameters

  • others: any[]

  Returns Grouping

inAll

• inAll(others): Grouping

• Parameters

  • others: any[]

  Returns Grouping

inAny

• inAny(others): Grouping

• Parameters

  • others: any[]

  Returns Grouping

inVal

• inVal(other): In

• Parameters

  • other: any

  Returns In

isDistinctFrom

• isDistinctFrom(other): IsDistinctFrom

• Parameters

  • other: any

  Returns IsDistinctFrom

isNotDistinctFrom

• isNotDistinctFrom(other): IsNotDistinctFrom

• Parameters

  • other: any

  Returns IsNotDistinctFrom

lower

• lower(column): NamedSQLFunction

• Parameters

  • column: any

  Returns NamedSQLFunction

lt

• lt(other): LessThan

• Parameters

  • other: any

  Returns LessThan

ltAll

• ltAll(others): Grouping

• Parameters

  • others: any[]

  Returns Grouping

ltAny

• ltAny(others): Grouping

• Parameters

  • others: any[]

  Returns Grouping

lteq

• lteq(other): LessThanOrEqual

• Parameters

  • other: any

  Returns LessThanOrEqual

lteqAll

• lteqAll(others): Grouping

• Parameters

  • others: any[]

  Returns Grouping

lteqAny

• lteqAny(others): Grouping

• Parameters

  • others: any[]

  Returns Grouping

matches

• matches(other, escape?, caseSensitive?): Matches

• Parameters

  • other: any

  • escape: any = null

  • caseSensitive: boolean = false

  Returns Matches

matchesAll

• matchesAll(others, escape?, caseSensitive?): Grouping

• Parameters

  • others: any[]

  • escape: any = null

  • caseSensitive: boolean = false

  Returns Grouping

matchesAny

• matchesAny(others, escape?, caseSensitive?): Grouping

• Parameters

  • others: any[]

  • escape: any = null

  • caseSensitive: boolean = false

  Returns Grouping

matchesRegexp

• matchesRegexp(other, caseSensitive?): Regexp

• Parameters

  • other: any

  • caseSensitive: boolean = true

  Returns Regexp

maximum

• maximum(): Max

• Returns Max

minimum

• minimum(): Min

• Returns Min

multiply

• multiply(other): Multiplication

• Parameters

  • other: any

  Returns Multiplication

not

• not(this): Not

• Parameters

  • this: Node

  Returns Not

notBetween

• notBetween(begin, end, inclusive?): Grouping | In | GreaterThan | GreaterThanOrEqual | LessThan

• Parameters

  • begin: number | BindParam | Quoted

  • end: number | BindParam | Quoted

  • inclusive: boolean = true

  Returns Grouping | In | GreaterThan | GreaterThanOrEqual | LessThan

notEq

• notEq(other): NotEqual

• Parameters

  • other: any

  Returns NotEqual

notEqAll

• notEqAll(others): Grouping

• Parameters

  • others: any[]

  Returns Grouping

notEqAny

• notEqAny(others): Grouping

• Parameters

  • others: any[]

  Returns Grouping

notInAll

• notInAll(others): Grouping

• Parameters

  • others: any[]

  Returns Grouping

notInAny

• notInAny(others): Grouping

• Parameters

  • others: any[]

  Returns Grouping

notInVal

• notInVal(other): NotIn

• Parameters

  • other: any

  Returns NotIn

or

• or<T>(right): Grouping

• Type Parameters

  • T extends Visitable

  Parameters

  • right: T

  Returns Grouping

quotedArray

• quotedArray(others): any[]

• Parameters

  • others: any[]

  Returns any[]

quotedNode

• quotedNode(other): any

• Parameters

  • other: any

  Returns any

subtract

• subtract(other): Grouping

• Parameters

  • other: any

  Returns Grouping

sum

• sum(): Sum

• Returns Sum

toSQL

• toSQL(engine?): any

• Parameters

  • engine: undefined | null | Engine = undefined

  Returns any

when

• when(other): Case

• Parameters

  • other: any

  Returns Case