datasource-definition
The schema defines the following additional types:
Properties of the SqliteDatasourceDefinition object:
Property | Type | Required | Description |
type | datasource.sqlite | true | |
instanceId | InstanceId | Expression | false | |
options | SqliteDatasourceOptions | true | |
parameters | parameter-definition | false | The datasource parameters. |
datasourceId | DatasourceId | false | Used to override the name of this Datasource. |
The datasource parameters.
Used to override the name of this Datasource.
The object must be any of the following types:
Properties of the SqliteDatasourceOptions object:
Property | Type | Required | Description |
provider | data-provider-definition | true | The provider that will get/set the data. |
entities | Array<data-provider-definition | SqliteDatasourceEntity> | true | The entities that the query will populate. |
query | string | true | The Sqlite query to execute. |
queryParameters | Expression | Primitive | false | The parameters for the query. |
isDocument | boolean | false | Some queries return their result as a single document instead of multiple rows. |
jsonProperties | string[] | null | false | An array of columns from the query to automatically parse as JSON objects. |
The provider that will get/set the data.
The entities that the query will populate.
The elements of the array must match at least one of the following properties:
The parameters for the query.
An array of columns from the query to automatically parse as JSON objects.
The object must be any of the following types:
The object is an array with all elements of the type string.
Properties of the SqliteDatasourceOptions object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_DYNAMIC | true | |
entities | Array<data-provider-definition | SqliteDatasourceDynamicEntity> | true | |
query | string | true | The Sqlite query to execute. |
queryParameters | Expression | Primitive | false | The parameters for the query. |
isDocument | boolean | false | Some queries return their result as a single document instead of multiple rows. |
jsonProperties | string[] | null | false | An array of columns from the query to automatically parse as JSON objects. |
The elements of the array must match at least one of the following properties:
The parameters for the query.
An array of columns from the query to automatically parse as JSON objects.
The object must be any of the following types:
The object is an array with all elements of the type string.
Properties of the SqliteDatasourceEntity object:
Property | Type | Required | Description |
entity | data-provider-definition | true | The name of the entity. |
function | string | false | The name of the function that will be executed. |
functionParameters | Expression | Primitive | false | The parameters for the function. |
The name of the entity.
The name of the function that will be executed.
The parameters for the function.
Properties of the SqliteDatasourceDynamicEntity object:
Property | Type | Required | Description |
entity | data-provider-definition | true | |
function | string | false | The name of the function that will be executed. |
functionParameters | Expression | Primitive | false | The parameters for the function. |
The name of the function that will be executed.
The parameters for the function.
Properties of the StaticDatasourceDefinition object:
Property | Type | Required | Description |
type | datasource.static | true | |
instanceId | InstanceId | Expression | false | |
options | StaticDatasourceOptions | true | |
parameters | parameter-definition | false | The datasource parameters. |
datasourceId | DatasourceId | false | Used to override the name of this Datasource. |
The datasource parameters.
Used to override the name of this Datasource.
Properties of the StaticDatasourceOptions object:
Property | Type | Required | Description |
data | | true | Data that will be stored under instance id and can be used in other components. |
Properties of the SystemDatasourceDefinition object:
Property | Type | Required | Description |
type | datasource.system | true | |
instanceId | InstanceId | Expression | false | |
options | SystemDatasourceOptions | true | |
parameters | parameter-definition | false | The datasource parameters. |
datasourceId | DatasourceId | false | Used to override the name of this Datasource. |
The datasource parameters.
Used to override the name of this Datasource.
Properties of the SystemDatasourceOptions object:
Property | Type | Required | Description |
source | SystemSourceType | true | Source of system data that can be used in other components. |
Source of system data that can be used in other components.
