v1.SQLDataset

v1.SQLDataset.data_sourceproperty

An optional data source id used for the specific dataset.

data_source?: string;

v1.SQLDataset.dataset_typeproperty

An optional dataset type. Standard datasets have direct data mapping. Auxiliary datasets are helper datasets without data mapping. Defaults to standard.

dataset_type?: "standard" | "auxiliary";

v1.SQLDataset.descriptionproperty

An optional description of the dataset.

description?: string;

v1.SQLDataset.fieldsproperty

fields?: Fields1;

v1.SQLDataset.idproperty

id: Id2;

v1.SQLDataset.precedenceproperty

An optional precedence value for the dataset (whole positive number).

precedence?: number;

v1.SQLDataset.primary_keyproperty

primary_key?: PrimaryKey1 | CompositePrimaryKey1;

v1.SQLDataset.referencesproperty

A list of references, specifies the relations between datasets. Foreign dataset is defined in “dataset” attribute and will always be joined by it’s grain. Current dataset will be join by the column name defined in “using” attribute.

references?: Reference[];

v1.SQLDataset.sqlproperty

A sql statement that represent a table.

sql: string;

v1.SQLDataset.table_pathproperty

A table path in the data source delimited by / character.

table_path?: string;

v1.SQLDataset.tagsproperty

tags?: Tags5;

v1.SQLDataset.titleproperty

An optional human readable title for the dataset. Will be derived from id if not provided explicitly.

title?: string;

v1.SQLDataset.typeproperty

type: "dataset";

v1.SQLDataset.workspace_data_filtersproperty

A list of workspace data filters to be applied to the dataset.

workspace_data_filters?: WorkspaceDataFilter[];