Polyglot SQL API Documentation - v0.9.2
GitHub
npm
Preparing search index...
compat
Expression
Class Expression
Index
Methods
add
and_
as_
asc
between
build
cast
ctas
desc
distinct
div
else_
eq
except_
for
Share
for
Update
from_
group
By
gt
gte
having
hint
ilike
insert
Columns
intersect
is
isin
is
Not
Null
is
Null
join
lateral
View
like
limit
lt
lte
merge
Using
mod
mul
neg
neq
not_
not
In
offset
or_
order
By
qualify
query
read
Dialect
rlike
select
set_
sort
By
sql
sub
subquery
union
values
when
when
Matched
Delete
when
Matched
Update
when
Not
Matched
Insert
where
window
xor
from
Node
Methods
add
add
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
and_
and_
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
as_
as_
(
alias
:
string
)
:
compat
.
Expression
Parameters
alias
:
string
Returns
compat
.
Expression
asc
asc
()
:
compat
.
Expression
Returns
compat
.
Expression
between
between
(
low
:
Input
,
high
:
Input
)
:
compat
.
Expression
Parameters
low
:
Input
high
:
Input
Returns
compat
.
Expression
build
build
()
:
unknown
Returns
unknown
cast
cast
(
to
:
string
)
:
compat
.
Expression
Parameters
to
:
string
Returns
compat
.
Expression
ctas
ctas
(
table
:
string
,
options
?:
{
replace
?:
boolean
;
temporary
?:
boolean
}
,
)
:
compat
.
Expression
Parameters
table
:
string
options
:
{
replace
?:
boolean
;
temporary
?:
boolean
}
= {}
Returns
compat
.
Expression
desc
desc
()
:
compat
.
Expression
Returns
compat
.
Expression
distinct
distinct
(
enabled
?:
boolean
)
:
compat
.
Expression
Parameters
enabled
:
boolean
= true
Returns
compat
.
Expression
div
div
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
else_
else_
(
result
:
Input
)
:
compat
.
Expression
Parameters
result
:
Input
Returns
compat
.
Expression
eq
eq
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
except_
except_
(
other
:
compat
.
Expression
,
distinct
?:
boolean
)
:
compat
.
Expression
Parameters
other
:
compat
.
Expression
distinct
:
boolean
= true
Returns
compat
.
Expression
for
Share
forShare
()
:
compat
.
Expression
Returns
compat
.
Expression
for
Update
forUpdate
()
:
compat
.
Expression
Returns
compat
.
Expression
from_
from_
(
source
:
Input
)
:
compat
.
Expression
Parameters
source
:
Input
Returns
compat
.
Expression
group
By
groupBy
(
...
expressions
:
Input
[]
)
:
compat
.
Expression
Parameters
...
expressions
:
Input
[]
Returns
compat
.
Expression
groupBy
(
options
:
ListOptions
,
...
expressions
:
Input
[]
)
:
compat
.
Expression
Parameters
options
:
ListOptions
...
expressions
:
Input
[]
Returns
compat
.
Expression
gt
gt
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
gte
gte
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
having
having
(
...
expressions
:
Input
[]
)
:
compat
.
Expression
Parameters
...
expressions
:
Input
[]
Returns
compat
.
Expression
having
(
options
:
ListOptions
,
...
expressions
:
Input
[]
)
:
compat
.
Expression
Parameters
options
:
ListOptions
...
expressions
:
Input
[]
Returns
compat
.
Expression
hint
hint
(
text
:
string
)
:
compat
.
Expression
Parameters
text
:
string
Returns
compat
.
Expression
ilike
ilike
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
insert
Columns
insertColumns
(
columns
:
string
[]
)
:
compat
.
Expression
Parameters
columns
:
string
[]
Returns
compat
.
Expression
intersect
intersect
(
other
:
compat
.
Expression
,
distinct
?:
boolean
)
:
compat
.
Expression
Parameters
other
:
compat
.
Expression
distinct
:
boolean
= true
Returns
compat
.
Expression
is
is
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
isin
isin
(
...
values
:
Input
[]
)
:
compat
.
Expression
Parameters
...
values
:
Input
[]
Returns
compat
.
Expression
is
Not
Null
isNotNull
()
:
compat
.
Expression
Returns
compat
.
Expression
is
Null
isNull
()
:
compat
.
Expression
Returns
compat
.
Expression
join
join
(
source
:
Input
,
options
?:
{
joinType
?:
JoinType
;
on
?:
Input
}
,
)
:
compat
.
Expression
Parameters
source
:
Input
options
:
{
joinType
?:
JoinType
;
on
?:
Input
}
= {}
Returns
compat
.
Expression
lateral
View
lateralView
(
expression
:
Input
,
options
?:
{
columnAliases
?:
string
[]
;
outer
?:
boolean
;
tableAlias
?:
string
;
}
,
)
:
compat
.
Expression
Parameters
expression
:
Input
options
:
{
columnAliases
?:
string
[]
;
outer
?:
boolean
;
tableAlias
?:
string
}
= {}
Returns
compat
.
Expression
like
like
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
limit
limit
(
expression
:
Input
)
:
compat
.
Expression
Parameters
expression
:
Input
Returns
compat
.
Expression
lt
lt
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
lte
lte
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
merge
Using
mergeUsing
(
source
:
Input
,
on
:
Input
)
:
compat
.
Expression
Parameters
source
:
Input
on
:
Input
Returns
compat
.
Expression
mod
mod
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
mul
mul
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
neg
neg
()
:
compat
.
Expression
Returns
compat
.
Expression
neq
neq
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
not_
not_
()
:
compat
.
Expression
Returns
compat
.
Expression
not
In
notIn
(
...
values
:
Input
[]
)
:
compat
.
Expression
Parameters
...
values
:
Input
[]
Returns
compat
.
Expression
offset
offset
(
expression
:
Input
)
:
compat
.
Expression
Parameters
expression
:
Input
Returns
compat
.
Expression
or_
or_
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
order
By
orderBy
(
...
expressions
:
Input
[]
)
:
compat
.
Expression
Parameters
...
expressions
:
Input
[]
Returns
compat
.
Expression
orderBy
(
options
:
ListOptions
,
...
expressions
:
Input
[]
)
:
compat
.
Expression
Parameters
options
:
ListOptions
...
expressions
:
Input
[]
Returns
compat
.
Expression
qualify
qualify
(
...
expressions
:
Input
[]
)
:
compat
.
Expression
Parameters
...
expressions
:
Input
[]
Returns
compat
.
Expression
qualify
(
options
:
ListOptions
,
...
expressions
:
Input
[]
)
:
compat
.
Expression
Parameters
options
:
ListOptions
...
expressions
:
Input
[]
Returns
compat
.
Expression
query
query
(
query
:
compat
.
Expression
)
:
compat
.
Expression
Parameters
query
:
compat
.
Expression
Returns
compat
.
Expression
read
Dialect
readDialect
(
dialect
:
string
)
:
compat
.
Expression
Use this source dialect when parsing string fragments in the plan.
Parameters
dialect
:
string
Returns
compat
.
Expression
rlike
rlike
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
select
select
(
...
expressions
:
Input
[]
)
:
compat
.
Expression
Parameters
...
expressions
:
Input
[]
Returns
compat
.
Expression
select
(
options
:
ListOptions
,
...
expressions
:
Input
[]
)
:
compat
.
Expression
Parameters
options
:
ListOptions
...
expressions
:
Input
[]
Returns
compat
.
Expression
set_
set_
(
assignments
:
Record
<
string
,
Input
>
)
:
compat
.
Expression
Parameters
assignments
:
Record
<
string
,
Input
>
Returns
compat
.
Expression
sort
By
sortBy
(
...
expressions
:
Input
[]
)
:
compat
.
Expression
Parameters
...
expressions
:
Input
[]
Returns
compat
.
Expression
sortBy
(
options
:
ListOptions
,
...
expressions
:
Input
[]
)
:
compat
.
Expression
Parameters
options
:
ListOptions
...
expressions
:
Input
[]
Returns
compat
.
Expression
sql
sql
(
dialect
?:
string
)
:
string
Parameters
dialect
:
string
= 'generic'
Returns
string
sub
sub
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
subquery
subquery
(
alias
?:
string
)
:
compat
.
Expression
Parameters
Optional
alias
:
string
Returns
compat
.
Expression
union
union
(
other
:
compat
.
Expression
,
distinct
?:
boolean
)
:
compat
.
Expression
Parameters
other
:
compat
.
Expression
distinct
:
boolean
= true
Returns
compat
.
Expression
values
values
(
...
rows
:
Input
[]
[]
)
:
compat
.
Expression
Parameters
...
rows
:
Input
[]
[]
Returns
compat
.
Expression
when
when
(
condition
:
Input
,
result
:
Input
)
:
compat
.
Expression
Parameters
condition
:
Input
result
:
Input
Returns
compat
.
Expression
when
Matched
Delete
whenMatchedDelete
(
condition
?:
Input
)
:
compat
.
Expression
Parameters
Optional
condition
:
Input
Returns
compat
.
Expression
when
Matched
Update
whenMatchedUpdate
(
assignments
:
Record
<
string
,
Input
>
,
condition
?:
Input
,
)
:
compat
.
Expression
Parameters
assignments
:
Record
<
string
,
Input
>
Optional
condition
:
Input
Returns
compat
.
Expression
when
Not
Matched
Insert
whenNotMatchedInsert
(
columns
:
string
[]
,
values
:
Input
[]
,
condition
?:
Input
,
)
:
compat
.
Expression
Parameters
columns
:
string
[]
values
:
Input
[]
Optional
condition
:
Input
Returns
compat
.
Expression
where
where
(
...
expressions
:
Input
[]
)
:
compat
.
Expression
Parameters
...
expressions
:
Input
[]
Returns
compat
.
Expression
where
(
options
:
ListOptions
,
...
expressions
:
Input
[]
)
:
compat
.
Expression
Parameters
options
:
ListOptions
...
expressions
:
Input
[]
Returns
compat
.
Expression
window
window
(
name
:
string
,
options
?:
{
orderBy
?:
Input
[]
;
partitionBy
?:
Input
[]
}
,
)
:
compat
.
Expression
Parameters
name
:
string
options
:
{
orderBy
?:
Input
[]
;
partitionBy
?:
Input
[]
}
= {}
Returns
compat
.
Expression
xor
xor
(
other
:
Input
)
:
compat
.
Expression
Parameters
other
:
Input
Returns
compat
.
Expression
Static
from
Node
fromNode
(
node
:
BuildNode
,
readDialect
?:
string
)
:
compat
.
Expression
Parameters
node
:
BuildNode
readDialect
:
string
= 'generic'
Returns
compat
.
Expression
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
add
and_
as_
asc
between
build
cast
ctas
desc
distinct
div
else_
eq
except_
for
Share
for
Update
from_
group
By
gt
gte
having
hint
ilike
insert
Columns
intersect
is
isin
is
Not
Null
is
Null
join
lateral
View
like
limit
lt
lte
merge
Using
mod
mul
neg
neq
not_
not
In
offset
or_
order
By
qualify
query
read
Dialect
rlike
select
set_
sort
By
sql
sub
subquery
union
values
when
when
Matched
Delete
when
Matched
Update
when
Not
Matched
Insert
where
window
xor
from
Node
GitHub
npm
Polyglot SQL API Documentation - v0.9.2
Loading...
Use this source dialect when parsing string fragments in the plan.