Forest Admin - API reference
Preparing search index...
@forestadmin/datasource-toolkit
BaseDataSource
Class BaseDataSource<T>
Type Parameters
T
extends
Collection
=
Collection
Hierarchy (
View Summary
)
BaseDataSource
MongooseDatasource
SequelizeDataSource
Implements
DataSource
Index
Constructors
constructor
Properties
_
collections
_
native
Query
Connections
Accessors
collections
native
Query
Connections
schema
Methods
add
Collection
add
Native
Query
Connection
execute
Native
Query
get
Collection
render
Chart
Constructors
constructor
new
BaseDataSource
<
T
extends
Collection
=
Collection
>
()
:
BaseDataSource
<
T
>
Type Parameters
T
extends
Collection
=
Collection
Returns
BaseDataSource
<
T
>
Properties
Protected
_
collections
_collections
:
{
[
collectionName
:
string
]:
T
}
= {}
Protected
_
native
Query
Connections
_nativeQueryConnections
:
{
[
connectionName
:
string
]:
unknown
}
= {}
Accessors
collections
get
collections
()
:
T
[]
Returns
T
[]
native
Query
Connections
get
nativeQueryConnections
()
:
Record
<
string
,
unknown
>
Returns
Record
<
string
,
unknown
>
schema
get
schema
()
:
DataSourceSchema
Returns
DataSourceSchema
Methods
add
Collection
addCollection
(
collection
:
T
)
:
void
Parameters
collection
:
T
Returns
void
add
Native
Query
Connection
addNativeQueryConnection
(
connectionName
:
string
,
definition
:
unknown
)
:
void
Parameters
connectionName
:
string
definition
:
unknown
Returns
void
execute
Native
Query
executeNativeQuery
(
connectionName
:
string
,
query
:
string
,
contextVariables
:
Record
<
string
,
unknown
>
,
)
:
Promise
<
unknown
>
Parameters
connectionName
:
string
query
:
string
contextVariables
:
Record
<
string
,
unknown
>
Returns
Promise
<
unknown
>
get
Collection
getCollection
(
name
:
string
)
:
T
Parameters
name
:
string
Returns
T
render
Chart
renderChart
(
caller
:
Caller
,
name
:
string
)
:
Promise
<
unknown
>
Parameters
caller
:
Caller
name
:
string
Returns
Promise
<
unknown
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
_
collections
_
native
Query
Connections
Accessors
collections
native
Query
Connections
schema
Methods
add
Collection
add
Native
Query
Connection
execute
Native
Query
get
Collection
render
Chart
Forest Admin - API reference
Loading...