Preparing search index...
The search index is not available
Forest Admin - API reference
Forest Admin - API reference
@forestadmin/datasource-mongoose
MongooseCollection
Class MongooseCollection
Hierarchy
BaseCollection
MongooseCollection
Index
Constructors
constructor
Properties
data
Source
model
name
native
Driver
schema
stack
Methods
add
Action
add
Chart
add
Field
add
Fields
add
Segments
aggregate
create
delete
enable
Count
enable
Search
execute
get
Form
list
render
Chart
update
Constructors
constructor
new
Mongoose
Collection
(
dataSource
:
DataSource
<
Collection
>
, model
:
Model
<
unknown
,
{}
,
{}
,
{}
,
Document
<
unknown
,
{}
,
unknown
>
&
Required
<
{
_id
:
unknown
;
}
>
,
any
>
, stack
:
Stack
)
:
MongooseCollection
Parameters
dataSource:
DataSource
<
Collection
>
model:
Model
<
unknown
,
{}
,
{}
,
{}
,
Document
<
unknown
,
{}
,
unknown
>
&
Required
<
{
_id
:
unknown
;
}
>
,
any
>
stack:
Stack
Returns
MongooseCollection
Properties
Readonly
data
Source
data
Source
:
DataSource
<
Collection
>
model
model
:
Model
<
unknown
,
{}
,
{}
,
{}
,
Document
<
unknown
,
{}
,
unknown
>
&
Required
<
{
_id
:
unknown
;
}
>
,
any
>
Readonly
name
name
:
string
Readonly
native
Driver
native
Driver
:
unknown
Readonly
schema
schema
:
CollectionSchema
stack
stack
:
Stack
Methods
Protected
add
Action
add
Action
(
name
:
string
, schema
:
ActionSchema
)
:
void
Parameters
name:
string
schema:
ActionSchema
Returns
void
Protected
add
Chart
add
Chart
(
name
:
string
)
:
void
Parameters
name:
string
Returns
void
Protected
add
Field
add
Field
(
name
:
string
, schema
:
FieldSchema
)
:
void
Parameters
name:
string
schema:
FieldSchema
Returns
void
Protected
add
Fields
add
Fields
(
fields
:
{
[fieldName:
string
]
:
FieldSchema
;
}
)
:
void
Parameters
fields:
{
[fieldName:
string
]
:
FieldSchema
;
}
[
fieldName:
string
]:
FieldSchema
Returns
void
Protected
add
Segments
add
Segments
(
segments
:
string
[]
)
:
void
Parameters
segments:
string
[]
Returns
void
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
>
Protected
enable
Count
enable
Count
(
)
:
void
Returns
void
Protected
enable
Search
enable
Search
(
)
:
void
Returns
void
execute
execute
(
caller
:
Caller
, name
:
string
)
:
Promise
<
ActionResult
>
Parameters
caller:
Caller
name:
string
Returns
Promise
<
ActionResult
>
get
Form
get
Form
(
)
:
Promise
<
ActionField
[]
>
Returns
Promise
<
ActionField
[]
>
list
list
(
caller
:
Caller
, filter
:
PaginatedFilter
, projection
:
Projection
)
:
Promise
<
RecordData
[]
>
Parameters
caller:
Caller
filter:
PaginatedFilter
projection:
Projection
Returns
Promise
<
RecordData
[]
>
render
Chart
render
Chart
(
caller
:
Caller
, name
:
string
)
:
Promise
<
unknown
>
Parameters
caller:
Caller
name:
string
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
Modules
Forest
Admin -
API reference
@forestadmin/agent
@forestadmin/datasource-
customizer
@forestadmin/datasource-
mongoose
@forestadmin/datasource-
sequelize
@forestadmin/datasource-
sql
@forestadmin/datasource-
toolkit
@forestadmin/plugin-
aws-
s3
@forestadmin/plugin-
export-
advanced
Mongoose
Collection
constructor
data
Source
model
name
native
Driver
schema
stack
add
Action
add
Chart
add
Field
add
Fields
add
Segments
aggregate
create
delete
enable
Count
enable
Search
execute
get
Form
list
render
Chart
update