Polyglot SQL API Documentation - v0.9.2
GitHub
npm
Preparing search index...
SelectBuilder
Class SelectBuilder
Hierarchy
StatefulBuilder
SelectBuilder
Index
Constructors
constructor
Methods
build
cross
Join
ctas
ctas
Sql
distinct
except
except
All
for
Share
for
Update
free
from
full
Join
group
By
having
hint
intersect
intersect
All
join
lateral
left
Join
limit
offset
order
By
qualify
right
Join
select
sort
By
to
Sql
union
union
All
where
window
Constructors
constructor
new
SelectBuilder
()
:
SelectBuilder
Returns
SelectBuilder
Methods
build
build
()
:
unknown
Returns
unknown
cross
Join
crossJoin
(
tableName
:
string
)
:
this
Parameters
tableName
:
string
Returns
this
ctas
ctas
(
tableName
:
string
,
options
?:
{
replace
?:
boolean
;
temporary
?:
boolean
}
,
)
:
unknown
Parameters
tableName
:
string
options
:
{
replace
?:
boolean
;
temporary
?:
boolean
}
= {}
Returns
unknown
ctas
Sql
ctasSql
(
tableName
:
string
,
dialect
?:
string
,
options
?:
{
replace
?:
boolean
;
temporary
?:
boolean
}
,
)
:
string
Parameters
tableName
:
string
dialect
:
string
= 'generic'
options
:
{
replace
?:
boolean
;
temporary
?:
boolean
}
= {}
Returns
string
distinct
distinct
()
:
this
Returns
this
except
except
(
other
:
SelectBuilder
)
:
SetOpBuilder
Parameters
other
:
SelectBuilder
Returns
SetOpBuilder
except
All
exceptAll
(
other
:
SelectBuilder
)
:
SetOpBuilder
Parameters
other
:
SelectBuilder
Returns
SetOpBuilder
for
Share
forShare
()
:
this
Returns
this
for
Update
forUpdate
()
:
this
Returns
this
free
free
()
:
void
Returns
void
from
from
(
tableOrExpression
:
string
|
Expr
)
:
this
Parameters
tableOrExpression
:
string
|
Expr
Returns
this
full
Join
fullJoin
(
tableName
:
string
,
on
:
ExprInput
)
:
this
Parameters
tableName
:
string
on
:
ExprInput
Returns
this
group
By
groupBy
(
...
expressions
:
ExprInput
[]
)
:
this
Parameters
...
expressions
:
ExprInput
[]
Returns
this
having
having
(
condition
:
ExprInput
)
:
this
Parameters
condition
:
ExprInput
Returns
this
hint
hint
(
text
:
string
)
:
this
Parameters
text
:
string
Returns
this
intersect
intersect
(
other
:
SelectBuilder
)
:
SetOpBuilder
Parameters
other
:
SelectBuilder
Returns
SetOpBuilder
intersect
All
intersectAll
(
other
:
SelectBuilder
)
:
SetOpBuilder
Parameters
other
:
SelectBuilder
Returns
SetOpBuilder
join
join
(
tableName
:
string
,
on
:
ExprInput
)
:
this
Parameters
tableName
:
string
on
:
ExprInput
Returns
this
lateral
lateral
(
functionExpression
:
Expr
,
tableAlias
:
string
,
columnAliases
:
string
[]
,
options
?:
{
outer
?:
boolean
}
,
)
:
this
Parameters
functionExpression
:
Expr
tableAlias
:
string
columnAliases
:
string
[]
options
:
{
outer
?:
boolean
}
= {}
Returns
this
left
Join
leftJoin
(
tableName
:
string
,
on
:
ExprInput
)
:
this
Parameters
tableName
:
string
on
:
ExprInput
Returns
this
limit
limit
(
value
:
number
)
:
this
Parameters
value
:
number
Returns
this
offset
offset
(
value
:
number
)
:
this
Parameters
value
:
number
Returns
this
order
By
orderBy
(
...
expressions
:
ExprInput
[]
)
:
this
Parameters
...
expressions
:
ExprInput
[]
Returns
this
qualify
qualify
(
condition
:
ExprInput
)
:
this
Parameters
condition
:
ExprInput
Returns
this
right
Join
rightJoin
(
tableName
:
string
,
on
:
ExprInput
)
:
this
Parameters
tableName
:
string
on
:
ExprInput
Returns
this
select
select
(
...
columns
:
ExprInput
[]
)
:
this
Parameters
...
columns
:
ExprInput
[]
Returns
this
sort
By
sortBy
(
...
expressions
:
ExprInput
[]
)
:
this
Parameters
...
expressions
:
ExprInput
[]
Returns
this
to
Sql
toSql
(
dialect
?:
string
)
:
string
Parameters
dialect
:
string
= 'generic'
Returns
string
union
union
(
other
:
SelectBuilder
)
:
SetOpBuilder
Parameters
other
:
SelectBuilder
Returns
SetOpBuilder
union
All
unionAll
(
other
:
SelectBuilder
)
:
SetOpBuilder
Parameters
other
:
SelectBuilder
Returns
SetOpBuilder
where
where
(
condition
:
ExprInput
)
:
this
Parameters
condition
:
ExprInput
Returns
this
window
window
(
name
:
string
,
definition
:
WindowDefBuilder
)
:
this
Parameters
name
:
string
definition
:
WindowDefBuilder
Returns
this
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
build
cross
Join
ctas
ctas
Sql
distinct
except
except
All
for
Share
for
Update
free
from
full
Join
group
By
having
hint
intersect
intersect
All
join
lateral
left
Join
limit
offset
order
By
qualify
right
Join
select
sort
By
to
Sql
union
union
All
where
window
GitHub
npm
Polyglot SQL API Documentation - v0.9.2
Loading...