IDeclarativeDataset
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Dataset of the logical data model.
export interface IDeclarativeDataset
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) | |||
(ALPHA) (Optional) | |||
(ALPHA) (Optional) Data source table that the dataset maps to. A dataset maps to a table or to an SQL statement. | |||
string | (ALPHA) (Optional) | ||
(ALPHA) (Optional) | |||
(ALPHA) | |||
string | (ALPHA) | ||
number | (ALPHA) (Optional) | ||
(ALPHA) | |||
(ALPHA) (Optional) SQL statement that the dataset maps to. A dataset maps to a table or to an SQL statement. | |||
string[] | (ALPHA) (Optional) | ||
string | (ALPHA) | ||
(ALPHA) (Optional) | |||
(ALPHA) (Optional) | |||
(ALPHA) (Optional) |
Property details
IDeclarativeDataset.aggregatedFactspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
aggregatedFacts?: IDeclarativeAggregatedFact[];
IDeclarativeDataset.attributespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
attributes?: IDeclarativeAttribute[];
IDeclarativeDataset.dataSourceTableIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Data source table that the dataset maps to. A dataset maps to a table or to an SQL statement.
dataSourceTableId?: IDeclarativeDataSourceTableIdentifier;
IDeclarativeDataset.descriptionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
description?: string;
IDeclarativeDataset.factspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
facts?: IDeclarativeFact[];
IDeclarativeDataset.grainpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
grain: IDeclarativeGrainIdentifier[];
IDeclarativeDataset.idpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
id: string;
IDeclarativeDataset.precedencepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
precedence?: number;
IDeclarativeDataset.referencespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
references: IDeclarativeReference[];
IDeclarativeDataset.sqlpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
SQL statement that the dataset maps to. A dataset maps to a table or to an SQL statement.
sql?: IDeclarativeDatasetSql;
IDeclarativeDataset.tagspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
tags?: string[];
IDeclarativeDataset.titlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
title: string;
IDeclarativeDataset.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
type?: DeclarativeDatasetType;
IDeclarativeDataset.workspaceDataFilterColumnspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
workspaceDataFilterColumns?: IDeclarativeWorkspaceDataFilterColumn[];
IDeclarativeDataset.workspaceDataFilterReferencespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
workspaceDataFilterReferences?: IDeclarativeWorkspaceDataFilterReference[];