Forest Admin - API reference
Preparing search index...
@forestadmin/datasource-toolkit
DataSourceDecorator
Class DataSourceDecorator<CollectionDecorator>
Type Parameters
CollectionDecorator
extends
Collection
=
Collection
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
DataSourceDecorator
<
CollectionDecorator
extends
Collection
=
Collection
>
(
childDataSource
:
DataSource
,
CollectionDecoratorCtor
:
CollectionDecoratorConstructor
<
CollectionDecorator
,
>
,
)
:
DataSourceDecorator
<
CollectionDecorator
>
Type Parameters
CollectionDecorator
extends
Collection
=
Collection
Parameters
childDataSource
:
DataSource
CollectionDecoratorCtor
:
CollectionDecoratorConstructor
<
CollectionDecorator
>
Returns
DataSourceDecorator
<
CollectionDecorator
>
Properties
Protected
Readonly
child
Data
Source
childDataSource
:
DataSource
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
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
)
:
CollectionDecorator
Parameters
name
:
string
Returns
CollectionDecorator
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
child
Data
Source
Accessors
collections
native
Query
Connections
schema
Methods
execute
Native
Query
get
Collection
render
Chart
Forest Admin - API reference
Loading...