Preparing search index...
The search index is not available
Forest Admin - API reference
Forest Admin - API reference
@forestadmin/datasource-toolkit
DataSourceDecorator
Class DataSourceDecorator<CollectionDecorator>
Type Parameters
CollectionDecorator
extends
Collection
=
Collection
Hierarchy
DataSourceDecorator
Implements
DataSource
<
CollectionDecorator
>
Index
Constructors
constructor
Properties
child
Data
Source
Accessors
collections
native
Query
Connections
schema
Methods
execute
Native
Query
get
Collection
render
Chart
Constructors
constructor
new
Data
Source
Decorator
<
CollectionDecorator
>
(
childDataSource
:
DataSource
<
Collection
>
, CollectionDecoratorCtor
:
CollectionDecoratorConstructor
<
CollectionDecorator
>
)
:
DataSourceDecorator
<
CollectionDecorator
>
Type Parameters
CollectionDecorator
extends
Collection
=
Collection
Parameters
childDataSource:
DataSource
<
Collection
>
CollectionDecoratorCtor:
CollectionDecoratorConstructor
<
CollectionDecorator
>
Returns
DataSourceDecorator
<
CollectionDecorator
>
Properties
Protected
Readonly
child
Data
Source
child
Data
Source
:
DataSource
<
Collection
>
Accessors
collections
get
collections
(
)
:
CollectionDecorator
[]
Returns
CollectionDecorator
[]
native
Query
Connections
get
nativeQueryConnections
(
)
:
Record
<
string
,
unknown
>
Returns
Record
<
string
,
unknown
>
schema
get
schema
(
)
:
DataSourceSchema
Returns
DataSourceSchema
Methods
execute
Native
Query
execute
Native
Query
(
connectionName
:
string
, query
:
string
, contextVariables
:
Record
<
string
,
unknown
>
)
:
Promise
<
unknown
>
Parameters
connectionName:
string
query:
string
contextVariables:
Record
<
string
,
unknown
>
Returns
Promise
<
unknown
>
get
Collection
get
Collection
(
name
:
string
)
:
CollectionDecorator
Parameters
name:
string
Returns
CollectionDecorator
render
Chart
render
Chart
(
caller
:
Caller
, name
:
string
)
:
Promise
<
unknown
>
Parameters
caller:
Caller
name:
string
Returns
Promise
<
unknown
>
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
Data
Source
Decorator
constructor
child
Data
Source
collections
native
Query
Connections
schema
execute
Native
Query
get
Collection
render
Chart