Class In

Hierarchy

Equality<any, Visitable | Visitable[]>
- In

Constructors

constructor

new In(left, right): In
Parameters
- left: any
- right: Visitable | Visitable[]
Returns In
Inherited from Equality.constructor
- Defined in src/nodes/Binary.ts:10

Properties

left

left: any

operator

operator: string = '=='

right

right: Visitable | Visitable[]

Accessors

operand1

get operand1(): L
Returns L
Inherited from Equality.operand1
- Defined in src/nodes/Equality.ts:6

operand2

get operand2(): R
Returns R
Inherited from Equality.operand2
- Defined in src/nodes/Equality.ts:10

Methods

add

add(other): Grouping
Parameters
- other: any
Returns Grouping
Inherited from Equality.add
- Defined in src/mixins/Math.ts:14

and

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

as

as(other): As
Parameters
- other: string | SQLLiteral
Returns As
Inherited from Equality.as
- Defined in src/mixins/AliasPredication.ts:5

asc

asc(this): Ascending
Parameters
- this: Visitable
Returns Ascending
Inherited from Equality.asc
- Defined in src/mixins/OrderPredications.ts:7

average

average(): Avg
Returns Avg
Inherited from Equality.average
- Defined in src/mixins/Expressions.ts:9

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
Inherited from Equality.between
- Defined in src/mixins/Predications.ts:257

bitwiseAnd

bitwiseAnd(other): Grouping
Parameters
- other: any
Returns Grouping
Inherited from Equality.bitwiseAnd
- Defined in src/mixins/Math.ts:18

bitwiseNot

bitwiseNot(): BitwiseNot
Returns BitwiseNot
Inherited from Equality.bitwiseNot
- Defined in src/mixins/Math.ts:22

bitwiseOr

bitwiseOr(other): Grouping
Parameters
- other: any
Returns Grouping
Inherited from Equality.bitwiseOr
- Defined in src/mixins/Math.ts:26

bitwiseShiftLeft

bitwiseShiftLeft(other): Grouping
Parameters
- other: any
Returns Grouping
Inherited from Equality.bitwiseShiftLeft
- Defined in src/mixins/Math.ts:30

bitwiseShiftRight

bitwiseShiftRight(other): Grouping
Parameters
- other: any
Returns Grouping
Inherited from Equality.bitwiseShiftRight
- Defined in src/mixins/Math.ts:34

bitwiseXor

bitwiseXor(other): Grouping
Parameters
- other: any
Returns Grouping
Inherited from Equality.bitwiseXor
- Defined in src/mixins/Math.ts:38

coalesce

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

concat

concat(other): Concat
Parameters
- other: any
Returns Concat
Inherited from Equality.concat
- Defined in src/mixins/ConcatPredication.ts:4

count

count(distinct?): Count
Parameters
- distinct: boolean = false
Returns Count
Inherited from Equality.count
- Defined in src/mixins/Expressions.ts:13

createAnd

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

createFalse

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

createJoin

createJoin(to): InnerJoin
Parameters
- to: null | string | SQLLiteral | Relation
Returns InnerJoin
Inherited from Equality.createJoin
- Defined in src/mixins/FactoryMethods.ts:34
createJoin(to, constraint): InnerJoin
Parameters
- to: null | string | SQLLiteral | Relation
- constraint: any
Returns InnerJoin
Inherited from Equality.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 Equality.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 Equality.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 Equality.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 Equality.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 Equality.createJoin
- Defined in src/mixins/FactoryMethods.ts:59

createOn

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

createStringJoin

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

createTableAlias

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

createTrue

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

desc

desc(this): Descending
Parameters
- this: Visitable
Returns Descending
Inherited from Equality.desc
- Defined in src/mixins/OrderPredications.ts:11

divide

divide(other): Division
Parameters
- other: any
Returns Division
Inherited from Equality.divide
- Defined in src/mixins/Math.ts:42

doesNotMatch

doesNotMatch(other, escape?, caseSensitive?): DoesNotMatch
Parameters
- other: any
- escape: any = null
- caseSensitive: boolean = false
Returns DoesNotMatch
Inherited from Equality.doesNotMatch
- Defined in src/mixins/Predications.ts:57

doesNotMatchAll

doesNotMatchAll(others, escape?, caseSensitive?): Grouping
Parameters
- others: any
- escape: any = null
- caseSensitive: boolean = false
Returns Grouping
Inherited from Equality.doesNotMatchAll
- Defined in src/mixins/Predications.ts:65

doesNotMatchAny

doesNotMatchAny(others, escape?, caseSensitive?): Grouping
Parameters
- others: any
- escape: any = null
- caseSensitive: boolean = false
Returns Grouping
Inherited from Equality.doesNotMatchAny
- Defined in src/mixins/Predications.ts:78

doesNotMatchRegexp

doesNotMatchRegexp(other, caseSensitive?): NotRegexp
Parameters
- other: any
- caseSensitive: boolean = true
Returns NotRegexp
Inherited from Equality.doesNotMatchRegexp
- Defined in src/mixins/Predications.ts:91

eq

eq(other): Equality<any, any>
Parameters
- other: any
Returns Equality<any, any>
Inherited from Equality.eq
- Defined in src/mixins/Predications.ts:95

eqAll

eqAll(others): Grouping
Parameters
- others: any[]
Returns Grouping
Inherited from Equality.eqAll
- Defined in src/mixins/Predications.ts:99

eqAny

eqAny(others): Grouping
Parameters
- others: any[]
Returns Grouping
Inherited from Equality.eqAny
- Defined in src/mixins/Predications.ts:103

extract

extract(field): Extract
Parameters
- field: any
Returns Extract
Inherited from Equality.extract
- Defined in src/mixins/Expressions.ts:17

grouping

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

`Protected` groupingAll

groupingAll(method, others, ...extras): Grouping
Parameters
- method: ((expr, ...extras) => any)
  - - (expr, ...extras): any
    - Parameters
      
      expr: any
      
      Rest ...extras: any[]
      
      Returns any
- others: any[]
- Rest ...extras: any[]
Returns Grouping
Inherited from Equality.groupingAll
- Defined in src/mixins/Predications.ts:25

`Protected` groupingAny

groupingAny(method, others, ...extras): Grouping
Parameters
- method: ((expr, ...extras) => any)
  - - (expr, ...extras): any
    - Parameters
      
      expr: any
      
      Rest ...extras: any[]
      
      Returns any
- others: any[]
- Rest ...extras: any[]
Returns Grouping
Inherited from Equality.groupingAny
- Defined in src/mixins/Predications.ts:35

gt

gt(other): GreaterThan
Parameters
- other: any
Returns GreaterThan
Inherited from Equality.gt
- Defined in src/mixins/Predications.ts:107

gtAll

gtAll(others): Grouping
Parameters
- others: any[]
Returns Grouping
Inherited from Equality.gtAll
- Defined in src/mixins/Predications.ts:111

gtAny

gtAny(others): Grouping
Parameters
- others: any[]
Returns Grouping
Inherited from Equality.gtAny
- Defined in src/mixins/Predications.ts:115

gteq

gteq(other): GreaterThanOrEqual
Parameters
- other: any
Returns GreaterThanOrEqual
Inherited from Equality.gteq
- Defined in src/mixins/Predications.ts:119

gteqAll

gteqAll(others): Grouping
Parameters
- others: any[]
Returns Grouping
Inherited from Equality.gteqAll
- Defined in src/mixins/Predications.ts:123

gteqAny

gteqAny(others): Grouping
Parameters
- others: any[]
Returns Grouping
Inherited from Equality.gteqAny
- Defined in src/mixins/Predications.ts:127

inAll

inAll(others): Grouping
Parameters
- others: any[]
Returns Grouping
Inherited from Equality.inAll
- Defined in src/mixins/Predications.ts:143

inAny

inAny(others): Grouping
Parameters
- others: any[]
Returns Grouping
Inherited from Equality.inAny
- Defined in src/mixins/Predications.ts:147

inVal

inVal(other): In
Parameters
- other: any
Returns In
Inherited from Equality.inVal
- Defined in src/mixins/Predications.ts:131

isDistinctFrom

isDistinctFrom(other): IsDistinctFrom
Parameters
- other: any
Returns IsDistinctFrom
Inherited from Equality.isDistinctFrom
- Defined in src/mixins/Predications.ts:155

`Protected` isInfinity

isInfinity(value): boolean
Parameters
- value: any
Returns boolean
Inherited from Equality.isInfinity
- Defined in src/mixins/Predications.ts:45

isNotDistinctFrom

isNotDistinctFrom(other): IsNotDistinctFrom
Parameters
- other: any
Returns IsNotDistinctFrom
Inherited from Equality.isNotDistinctFrom
- Defined in src/mixins/Predications.ts:151

`Protected` isOpenEnded

isOpenEnded(value): boolean
Parameters
- value: any
Returns boolean
Inherited from Equality.isOpenEnded
- Defined in src/mixins/Predications.ts:49

`Protected` isUnboundable

isUnboundable(value): boolean
Parameters
- value: any
Returns boolean
Inherited from Equality.isUnboundable
- Defined in src/mixins/Predications.ts:53

lower

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

lt

lt(other): LessThan
Parameters
- other: any
Returns LessThan
Inherited from Equality.lt
- Defined in src/mixins/Predications.ts:159

ltAll

ltAll(others): Grouping
Parameters
- others: any[]
Returns Grouping
Inherited from Equality.ltAll
- Defined in src/mixins/Predications.ts:163

ltAny

ltAny(others): Grouping
Parameters
- others: any[]
Returns Grouping
Inherited from Equality.ltAny
- Defined in src/mixins/Predications.ts:167

lteq

lteq(other): LessThanOrEqual
Parameters
- other: any
Returns LessThanOrEqual
Inherited from Equality.lteq
- Defined in src/mixins/Predications.ts:171

lteqAll

lteqAll(others): Grouping
Parameters
- others: any[]
Returns Grouping
Inherited from Equality.lteqAll
- Defined in src/mixins/Predications.ts:175

lteqAny

lteqAny(others): Grouping
Parameters
- others: any[]
Returns Grouping
Inherited from Equality.lteqAny
- Defined in src/mixins/Predications.ts:179

matches

matches(other, escape?, caseSensitive?): Matches
Parameters
- other: any
- escape: any = null
- caseSensitive: boolean = false
Returns Matches
Inherited from Equality.matches
- Defined in src/mixins/Predications.ts:183

matchesAll

matchesAll(others, escape?, caseSensitive?): Grouping
Parameters
- others: any[]
- escape: any = null
- caseSensitive: boolean = false
Returns Grouping
Inherited from Equality.matchesAll
- Defined in src/mixins/Predications.ts:187

matchesAny

matchesAny(others, escape?, caseSensitive?): Grouping
Parameters
- others: any[]
- escape: any = null
- caseSensitive: boolean = false
Returns Grouping
Inherited from Equality.matchesAny
- Defined in src/mixins/Predications.ts:200

matchesRegexp

matchesRegexp(other, caseSensitive?): Regexp
Parameters
- other: any
- caseSensitive: boolean = true
Returns Regexp
Inherited from Equality.matchesRegexp
- Defined in src/mixins/Predications.ts:213

maximum

maximum(): Max
Returns Max
Inherited from Equality.maximum
- Defined in src/mixins/Expressions.ts:21

minimum

minimum(): Min
Returns Min
Inherited from Equality.minimum
- Defined in src/mixins/Expressions.ts:25

multiply

multiply(other): Multiplication
Parameters
- other: any
Returns Multiplication
Inherited from Equality.multiply
- Defined in src/mixins/Math.ts:46

not

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

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
Inherited from Equality.notBetween
- Defined in src/mixins/Predications.ts:292

notEq

notEq(other): NotEqual
Parameters
- other: any
Returns NotEqual
Inherited from Equality.notEq
- Defined in src/mixins/Predications.ts:217

notEqAll

notEqAll(others): Grouping
Parameters
- others: any[]
Returns Grouping
Inherited from Equality.notEqAll
- Defined in src/mixins/Predications.ts:221

notEqAny

notEqAny(others): Grouping
Parameters
- others: any[]
Returns Grouping
Inherited from Equality.notEqAny
- Defined in src/mixins/Predications.ts:225

notInAll

notInAll(others): Grouping
Parameters
- others: any[]
Returns Grouping
Inherited from Equality.notInAll
- Defined in src/mixins/Predications.ts:241

notInAny

notInAny(others): Grouping
Parameters
- others: any[]
Returns Grouping
Inherited from Equality.notInAny
- Defined in src/mixins/Predications.ts:245

notInVal

notInVal(other): NotIn
Parameters
- other: any
Returns NotIn
Inherited from Equality.notInVal
- Defined in src/mixins/Predications.ts:229

or

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

quotedArray

quotedArray(others): any[]
Parameters
- others: any[]
Returns any[]
Inherited from Equality.quotedArray
- Defined in src/mixins/Predications.ts:253

quotedNode

quotedNode(other): any
Parameters
- other: any
Returns any
Inherited from Equality.quotedNode
- Defined in src/mixins/Predications.ts:249

subtract

subtract(other): Grouping
Parameters
- other: any
Returns Grouping
Inherited from Equality.subtract
- Defined in src/mixins/Math.ts:50

sum

sum(): Sum
Returns Sum
Inherited from Equality.sum
- Defined in src/mixins/Expressions.ts:29

toSQL

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

when

when(other): Case
Parameters
- other: any
Returns Case
Inherited from Equality.when
- Defined in src/mixins/WhenPredication.ts:5

Class In

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

left: any

right: Visitable | Visitable[]

Returns In

Properties

left

operator

right

Accessors

operand1

Returns L

operand2

Returns R

Methods

add

Parameters

other: any

Returns Grouping

and

Parameters

right: any

Returns And

as

Parameters

other: string | SQLLiteral

Returns As

asc

Parameters

this: Visitable

Returns Ascending

average

Returns Avg

between

Parameters

begin: number | BindParam | Quoted

end: number | BindParam | Quoted

inclusive: boolean = true

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

bitwiseAnd

Parameters

other: any

Returns Grouping

bitwiseNot

Returns BitwiseNot

bitwiseOr

Parameters

other: any

Returns Grouping

bitwiseShiftLeft

Parameters

other: any

Returns Grouping

bitwiseShiftRight

Parameters

other: any

Returns Grouping

bitwiseXor

Parameters

other: any

Returns Grouping

coalesce

Parameters

Rest ...exprs: any[]

Returns NamedSQLFunction

concat

Parameters

other: any

Returns Concat

count

Parameters

distinct: boolean = false

`Rest` ...exprs: any[]