Typegres API Reference - v0.2.0
Preparing search index...
Database
Class Database<C>
Type Parameters
C
=
undefined
Index
Constructors
constructor
Methods
close
execute
from
hydrate
install
Live
Events
live
start
Live
stop
Live
Table
transaction
values
Constructors
constructor
new
Database
<
C
=
undefined
>
(
driver
:
Driver
,
boundExecute
?:
ExecuteFn
,
isolation
?:
TransactionIsolation
,
)
:
Database
<
C
>
Type Parameters
C
=
undefined
Parameters
driver
:
Driver
Optional
boundExecute
:
ExecuteFn
Optional
isolation
:
TransactionIsolation
Returns
Database
<
C
>
Methods
close
close
()
:
Promise
<
void
>
Returns
Promise
<
void
>
execute
execute
<
Q
extends
QueryBuilder
<
any
,
any
,
any
,
any
>
>
(
query
:
Q
,
)
:
Promise
<
Q
extends
QueryBuilder
<
any
,
O
,
any
,
any
>
?
RowTypeToTsType
<
O
>
[]
:
never
,
>
Type Parameters
Q
extends
QueryBuilder
<
any
,
any
,
any
,
any
>
Parameters
query
:
Q
Returns
Promise
<
Q
extends
QueryBuilder
<
any
,
O
,
any
,
any
>
?
RowTypeToTsType
<
O
>
[]
:
never
>
execute
<
Q
extends
InsertBuilder
<
any
,
any
,
any
>
>
(
query
:
Q
,
)
:
Promise
<
Q
extends
InsertBuilder
<
any
,
any
,
R
>
?
RowTypeToTsType
<
R
>
[]
:
never
,
>
Type Parameters
Q
extends
InsertBuilder
<
any
,
any
,
any
>
Parameters
query
:
Q
Returns
Promise
<
Q
extends
InsertBuilder
<
any
,
any
,
R
>
?
RowTypeToTsType
<
R
>
[]
:
never
>
execute
<
Q
extends
UpdateBuilder
<
any
,
any
,
any
>
>
(
query
:
Q
,
)
:
Promise
<
Q
extends
UpdateBuilder
<
any
,
any
,
R
>
?
RowTypeToTsType
<
R
>
[]
:
never
,
>
Type Parameters
Q
extends
UpdateBuilder
<
any
,
any
,
any
>
Parameters
query
:
Q
Returns
Promise
<
Q
extends
UpdateBuilder
<
any
,
any
,
R
>
?
RowTypeToTsType
<
R
>
[]
:
never
>
execute
<
Q
extends
DeleteBuilder
<
any
,
any
,
any
>
>
(
query
:
Q
,
)
:
Promise
<
Q
extends
DeleteBuilder
<
any
,
any
,
R
>
?
RowTypeToTsType
<
R
>
[]
:
never
,
>
Type Parameters
Q
extends
DeleteBuilder
<
any
,
any
,
any
>
Parameters
query
:
Q
Returns
Promise
<
Q
extends
DeleteBuilder
<
any
,
any
,
R
>
?
RowTypeToTsType
<
R
>
[]
:
never
>
execute
(
query
:
Sql
)
:
Promise
<
QueryResult
>
Parameters
query
:
Sql
Returns
Promise
<
QueryResult
>
from
from
<
R
extends
RowType
,
A
extends
string
>
(
from
:
Fromable
<
R
,
A
>
,
)
:
QueryBuilder
<
{
[
K
in
string
]
:
R
}
,
R
,
[
]
>
Type Parameters
R
extends
RowType
A
extends
string
Parameters
from
:
Fromable
<
R
,
A
>
Returns
QueryBuilder
<
{
[
K
in
string
]
:
R
}
,
R
,
[
]
>
hydrate
hydrate
<
O
extends
RowType
,
GB
extends
any
[]
,
Card
extends
"one"
|
"maybe"
|
"many"
,
>
(
query
:
QueryBuilder
<
any
,
O
,
GB
,
Card
>
,
)
:
Promise
<
O
[]
>
Type Parameters
O
extends
RowType
GB
extends
any
[]
Card
extends
"one"
|
"maybe"
|
"many"
Parameters
query
:
QueryBuilder
<
any
,
O
,
GB
,
Card
>
Returns
Promise
<
O
[]
>
hydrate
<
Name
extends
string
,
T
extends
TableBase
,
R
extends
RowType
>
(
query
:
InsertBuilder
<
Name
,
T
,
R
>
,
)
:
Promise
<
R
[]
>
Type Parameters
Name
extends
string
T
extends
TableBase
R
extends
RowType
Parameters
query
:
InsertBuilder
<
Name
,
T
,
R
>
Returns
Promise
<
R
[]
>
hydrate
<
Name
extends
string
,
T
extends
TableBase
,
R
extends
RowType
>
(
query
:
UpdateBuilder
<
Name
,
T
,
R
>
,
)
:
Promise
<
R
[]
>
Type Parameters
Name
extends
string
T
extends
TableBase
R
extends
RowType
Parameters
query
:
UpdateBuilder
<
Name
,
T
,
R
>
Returns
Promise
<
R
[]
>
hydrate
<
Name
extends
string
,
T
extends
TableBase
,
R
extends
RowType
>
(
query
:
DeleteBuilder
<
Name
,
T
,
R
>
,
)
:
Promise
<
R
[]
>
Type Parameters
Name
extends
string
T
extends
TableBase
R
extends
RowType
Parameters
query
:
DeleteBuilder
<
Name
,
T
,
R
>
Returns
Promise
<
R
[]
>
install
Live
Events
installLiveEvents
()
:
Promise
<
void
>
Returns
Promise
<
void
>
live
live
<
Q
extends
QueryBuilder
<
any
,
any
,
any
,
any
>
>
(
query
:
Q
,
)
:
AsyncIterable
<
Q
extends
QueryBuilder
<
any
,
O
,
any
,
any
>
?
RowTypeToTsType
<
O
>
[]
:
never
,
>
Type Parameters
Q
extends
QueryBuilder
<
any
,
any
,
any
,
any
>
Parameters
query
:
Q
Returns
AsyncIterable
<
Q
extends
QueryBuilder
<
any
,
O
,
any
,
any
>
?
RowTypeToTsType
<
O
>
[]
:
never
,
>
start
Live
startLive
(
opts
?:
BusOptions
)
:
Promise
<
void
>
Parameters
opts
:
BusOptions
= {}
Returns
Promise
<
void
>
stop
Live
stopLive
()
:
Promise
<
void
>
Returns
Promise
<
void
>
Table
Table
<
Name
extends
string
>
(
name
:
Name
,
opts
?:
TableOptions
)
:
typeof
__class
Type Parameters
Name
extends
string
Parameters
name
:
Name
opts
:
TableOptions
= {}
Returns
typeof
__class
transaction
transaction
<
T
>
(
fn
:
(
tx
:
Database
<
C
>
)
=>
Promise
<
T
>
)
:
Promise
<
T
>
Type Parameters
T
Parameters
fn
:
(
tx
:
Database
<
C
>
)
=>
Promise
<
T
>
Returns
Promise
<
T
>
transaction
<
T
>
(
opts
:
TransactionOptions
,
fn
:
(
tx
:
Database
<
C
>
)
=>
Promise
<
T
>
,
)
:
Promise
<
T
>
Type Parameters
T
Parameters
opts
:
TransactionOptions
fn
:
(
tx
:
Database
<
C
>
)
=>
Promise
<
T
>
Returns
Promise
<
T
>
values
values
<
R
extends
RowType
>
(
vals0
:
R
,
...
valsRest
:
(
NoInfer
<
R
>
|
RowTypeToTsType
<
NoInfer
<
R
>
>
)
[]
,
)
:
QueryBuilder
<
{
values
:
R
}
,
R
,
[
]
>
Type Parameters
R
extends
RowType
Parameters
vals0
:
R
...
valsRest
: (
NoInfer
<
R
>
|
RowTypeToTsType
<
NoInfer
<
R
>
>
)
[]
Returns
QueryBuilder
<
{
values
:
R
}
,
R
,
[
]
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
close
execute
from
hydrate
install
Live
Events
live
start
Live
stop
Live
Table
transaction
values
Typegres API Reference - v0.2.0
Loading...