Documentation
Preparing search index...
@quatrain/backend
BackendInterface
Interface BackendInterface
interface
BackendInterface
{
aggregate
(
query
:
Query
<
any
>
,
operation
:
"sum"
|
"avg"
|
"distinct"
|
"min"
|
"max"
|
"count"
,
property
?:
string
,
)
:
Promise
<
any
>
;
create
(
dataObject
:
DataObjectClass
<
any
>
,
desiredUid
:
string
|
undefined
,
)
:
Promise
<
DataObjectClass
<
any
>
>
;
delete
(
dataObject
:
DataObjectClass
<
any
>
,
hardDelete
?:
boolean
,
)
:
Promise
<
DataObjectClass
<
any
>
>
;
find
(
dataObject
:
DataObjectClass
<
any
>
,
filters
:
Filter
[]
|
Filters
|
undefined
,
pagination
:
SortAndLimit
|
undefined
,
parent
:
any
,
)
:
Promise
<
QueryResultType
<
DataObjectClass
<
any
>
>
>
;
generateCreateSql
(
collection
:
string
,
properties
:
any
[]
,
)
:
{
downSql
:
string
;
upSql
:
string
}
;
generateDeltaSql
(
collection
:
string
,
delta
:
SchemaDelta
,
)
:
{
downSql
:
string
[]
;
upSql
:
string
[]
}
;
query
(
query
:
Query
<
any
>
)
:
Promise
<
QueryResultType
<
DataObjectClass
<
any
>
>
>
;
read
(
param
:
string
|
DataObjectClass
<
any
>
)
:
Promise
<
DataObjectClass
<
any
>
>
;
update
(
dataObject
:
DataObjectClass
<
any
>
)
:
Promise
<
DataObjectClass
<
any
>
>
;
}
Implemented by
AbstractBackendAdapter
MockAdapter
Index
Methods
aggregate
create
delete
find
generate
Create
Sql
generate
Delta
Sql
query
read
update
Methods
aggregate
aggregate
(
query
:
Query
<
any
>
,
operation
:
"sum"
|
"avg"
|
"distinct"
|
"min"
|
"max"
|
"count"
,
property
?:
string
,
)
:
Promise
<
any
>
Parameters
query
:
Query
<
any
>
operation
:
"sum"
|
"avg"
|
"distinct"
|
"min"
|
"max"
|
"count"
Optional
property
:
string
Returns
Promise
<
any
>
create
create
(
dataObject
:
DataObjectClass
<
any
>
,
desiredUid
:
string
|
undefined
,
)
:
Promise
<
DataObjectClass
<
any
>
>
Parameters
dataObject
:
DataObjectClass
<
any
>
desiredUid
:
string
|
undefined
Returns
Promise
<
DataObjectClass
<
any
>
>
delete
delete
(
dataObject
:
DataObjectClass
<
any
>
,
hardDelete
?:
boolean
,
)
:
Promise
<
DataObjectClass
<
any
>
>
Parameters
dataObject
:
DataObjectClass
<
any
>
Optional
hardDelete
:
boolean
Returns
Promise
<
DataObjectClass
<
any
>
>
find
find
(
dataObject
:
DataObjectClass
<
any
>
,
filters
:
Filter
[]
|
Filters
|
undefined
,
pagination
:
SortAndLimit
|
undefined
,
parent
:
any
,
)
:
Promise
<
QueryResultType
<
DataObjectClass
<
any
>
>
>
Parameters
dataObject
:
DataObjectClass
<
any
>
filters
:
Filter
[]
|
Filters
|
undefined
pagination
:
SortAndLimit
|
undefined
parent
:
any
Returns
Promise
<
QueryResultType
<
DataObjectClass
<
any
>
>
>
generate
Create
Sql
generateCreateSql
(
collection
:
string
,
properties
:
any
[]
,
)
:
{
downSql
:
string
;
upSql
:
string
}
Parameters
collection
:
string
properties
:
any
[]
Returns
{
downSql
:
string
;
upSql
:
string
}
generate
Delta
Sql
generateDeltaSql
(
collection
:
string
,
delta
:
SchemaDelta
,
)
:
{
downSql
:
string
[]
;
upSql
:
string
[]
}
Parameters
collection
:
string
delta
:
SchemaDelta
Returns
{
downSql
:
string
[]
;
upSql
:
string
[]
}
query
query
(
query
:
Query
<
any
>
)
:
Promise
<
QueryResultType
<
DataObjectClass
<
any
>
>
>
Parameters
query
:
Query
<
any
>
Returns
Promise
<
QueryResultType
<
DataObjectClass
<
any
>
>
>
read
read
(
param
:
string
|
DataObjectClass
<
any
>
)
:
Promise
<
DataObjectClass
<
any
>
>
Parameters
param
:
string
|
DataObjectClass
<
any
>
Returns
Promise
<
DataObjectClass
<
any
>
>
update
update
(
dataObject
:
DataObjectClass
<
any
>
)
:
Promise
<
DataObjectClass
<
any
>
>
Parameters
dataObject
:
DataObjectClass
<
any
>
Returns
Promise
<
DataObjectClass
<
any
>
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
aggregate
create
delete
find
generate
Create
Sql
generate
Delta
Sql
query
read
update
Documentation
Loading...