Forest Admin - API reference
Preparing search index...
@forestadmin/datasource-toolkit
DataSource
Interface DataSource<C>
interface
DataSource
<
C
extends
Collection
=
Collection
>
{
get
collections
()
:
C
[]
;
get
nativeQueryConnections
()
:
Record
<
string
,
unknown
>
;
get
schema
()
:
DataSourceSchema
;
executeNativeQuery
(
connectionName
:
string
,
query
:
string
,
contextVariables
:
Record
<
string
,
unknown
>
,
)
:
Promise
<
unknown
>
;
getCollection
(
name
:
string
)
:
C
;
renderChart
(
caller
:
Caller
,
name
:
string
)
:
Promise
<
unknown
>
;
}
Type Parameters
C
extends
Collection
=
Collection
Implemented by
BaseDataSource
DataSourceDecorator
Index
Accessors
collections
native
Query
Connections
schema
Methods
execute
Native
Query
get
Collection
render
Chart
Accessors
collections
get
collections
()
:
C
[]
Returns
C
[]
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
)
:
C
Parameters
name
:
string
Returns
C
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
Accessors
collections
native
Query
Connections
schema
Methods
execute
Native
Query
get
Collection
render
Chart
Forest Admin - API reference
Loading...