Forest Admin - API reference
Preparing search index...
@forestadmin/datasource-toolkit
Collection
Interface Collection
interface
Collection
{
get
dataSource
()
:
DataSource
;
get
name
()
:
string
;
get
nativeDriver
()
:
unknown
;
get
schema
()
:
CollectionSchema
;
aggregate
(
caller
:
Caller
,
filter
:
Filter
,
aggregation
:
Aggregation
,
limit
?:
number
,
)
:
Promise
<
AggregateResult
[]
>
;
create
(
caller
:
Caller
,
data
:
RecordData
[]
)
:
Promise
<
RecordData
[]
>
;
delete
(
caller
:
Caller
,
filter
:
Filter
)
:
Promise
<
void
>
;
execute
(
caller
:
Caller
,
name
:
string
,
formValues
:
RecordData
,
filter
?:
Filter
,
)
:
Promise
<
ActionResult
>
;
getForm
(
caller
:
Caller
,
name
:
string
,
formValues
?:
RecordData
,
filter
?:
Filter
,
metas
?:
GetFormMetas
,
)
:
Promise
<
ActionFormElement
[]
>
;
list
(
caller
:
Caller
,
filter
:
PaginatedFilter
,
projection
:
Projection
,
)
:
Promise
<
RecordData
[]
>
;
renderChart
(
caller
:
Caller
,
name
:
string
,
recordId
:
CompositeId
,
)
:
Promise
<
unknown
>
;
update
(
caller
:
Caller
,
filter
:
Filter
,
patch
:
RecordData
)
:
Promise
<
void
>
;
}
Implemented by
BaseCollection
CollectionDecorator
Index
Accessors
data
Source
name
native
Driver
schema
Methods
aggregate
create
delete
execute
get
Form
list
render
Chart
update
Accessors
data
Source
get
dataSource
()
:
DataSource
Returns
DataSource
name
get
name
()
:
string
Returns
string
native
Driver
get
nativeDriver
()
:
unknown
Returns
unknown
schema
get
schema
()
:
CollectionSchema
Returns
CollectionSchema
Methods
aggregate
aggregate
(
caller
:
Caller
,
filter
:
Filter
,
aggregation
:
Aggregation
,
limit
?:
number
,
)
:
Promise
<
AggregateResult
[]
>
Parameters
caller
:
Caller
filter
:
Filter
aggregation
:
Aggregation
Optional
limit
:
number
Returns
Promise
<
AggregateResult
[]
>
create
create
(
caller
:
Caller
,
data
:
RecordData
[]
)
:
Promise
<
RecordData
[]
>
Parameters
caller
:
Caller
data
:
RecordData
[]
Returns
Promise
<
RecordData
[]
>
delete
delete
(
caller
:
Caller
,
filter
:
Filter
)
:
Promise
<
void
>
Parameters
caller
:
Caller
filter
:
Filter
Returns
Promise
<
void
>
execute
execute
(
caller
:
Caller
,
name
:
string
,
formValues
:
RecordData
,
filter
?:
Filter
,
)
:
Promise
<
ActionResult
>
Parameters
caller
:
Caller
name
:
string
formValues
:
RecordData
Optional
filter
:
Filter
Returns
Promise
<
ActionResult
>
get
Form
getForm
(
caller
:
Caller
,
name
:
string
,
formValues
?:
RecordData
,
filter
?:
Filter
,
metas
?:
GetFormMetas
,
)
:
Promise
<
ActionFormElement
[]
>
Parameters
caller
:
Caller
name
:
string
Optional
formValues
:
RecordData
Optional
filter
:
Filter
Optional
metas
:
GetFormMetas
Returns
Promise
<
ActionFormElement
[]
>
list
list
(
caller
:
Caller
,
filter
:
PaginatedFilter
,
projection
:
Projection
,
)
:
Promise
<
RecordData
[]
>
Parameters
caller
:
Caller
filter
:
PaginatedFilter
projection
:
Projection
Returns
Promise
<
RecordData
[]
>
render
Chart
renderChart
(
caller
:
Caller
,
name
:
string
,
recordId
:
CompositeId
,
)
:
Promise
<
unknown
>
Parameters
caller
:
Caller
name
:
string
recordId
:
CompositeId
Returns
Promise
<
unknown
>
update
update
(
caller
:
Caller
,
filter
:
Filter
,
patch
:
RecordData
)
:
Promise
<
void
>
Parameters
caller
:
Caller
filter
:
Filter
patch
:
RecordData
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Accessors
data
Source
name
native
Driver
schema
Methods
aggregate
create
delete
execute
get
Form
list
render
Chart
update
Forest Admin - API reference
Loading...