Class Attribute

Hierarchy

default
default
default
default
default
default
default
- Attribute
  - Boolean
  - Decimal
  - Float
  - Integer
  - String
  - Time
  - Undefined

Constructors

constructor

new Attribute(relation, name): Attribute
Parameters
- relation: Relation
- name: string | SQLLiteral
Returns Attribute
- Defined in src/attributes/Attribute.ts:24

Properties

name

name: string | SQLLiteral

relation

relation: Relation

Methods

add

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

as

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

asc

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

average

average(): Avg
Returns Avg
- 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
- Defined in src/mixins/Predications.ts:257

bitwiseAnd

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

bitwiseNot

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

bitwiseOr

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

bitwiseShiftLeft

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

bitwiseShiftRight

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

bitwiseXor

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

concat

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

count

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

desc

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

divide

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

doesNotMatch

doesNotMatch(other, escape?, caseSensitive?): DoesNotMatch
Parameters
- other: any
- escape: any = null
- caseSensitive: boolean = false
Returns 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
- Defined in src/mixins/Predications.ts:65

doesNotMatchAny

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

doesNotMatchRegexp

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

eq

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

eqAll

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

eqAny

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

extract

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

`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
- 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
- Defined in src/mixins/Predications.ts:35

gt

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

gtAll

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

gtAny

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

gteq

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

gteqAll

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

gteqAny

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

inAll

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

inAny

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

inVal

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

isAbleToTypeCast

isAbleToTypeCast(): boolean
Returns boolean
- Defined in src/attributes/Attribute.ts:29

isDistinctFrom

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

`Protected` isInfinity

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

isNotDistinctFrom

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

`Protected` isOpenEnded

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

`Protected` isUnboundable

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

lower

lower(): NamedSQLFunction
Returns NamedSQLFunction
- Defined in src/attributes/Attribute.ts:33

lt

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

ltAll

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

ltAny

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

lteq

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

lteqAll

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

lteqAny

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

matches

matches(other, escape?, caseSensitive?): Matches
Parameters
- other: any
- escape: any = null
- caseSensitive: boolean = false
Returns 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
- Defined in src/mixins/Predications.ts:187

matchesAny

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

matchesRegexp

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

maximum

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

minimum

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

multiply

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

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

notEq

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

notEqAll

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

notEqAny

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

notInAll

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

notInAny

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

notInVal

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

quotedArray

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

quotedNode

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

subtract

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

sum

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

typeCastForDatabase

typeCastForDatabase(value): string | number
Parameters
- value: Visitable
Returns string | number
- Defined in src/attributes/Attribute.ts:37

when

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

Generated using TypeDoc