v1.AuxiliaryDataset
Synthetic reference target for pre-aggregation datasets. Per gdc-nas, AUX datasets must not carry table_path, sql, precedence, or workspace_data_filters; data lives in the referencing pre-aggregation datasets.
export interface AuxiliaryDataset
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (Optional) An optional data source id used for the specific dataset. | ||
“auxiliary” | |||
string | (Optional) An optional description of the dataset. | ||
(Optional) | |||
never | (Optional) | ||
(Optional) | |||
(Optional) 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. | |||
never | (Optional) | ||
never | (Optional) | ||
(Optional) | |||
string | (Optional) An optional human readable title for the dataset. Will be derived from id if not provided explicitly. | ||
“dataset” | |||
never | (Optional) |
Property details
v1.AuxiliaryDataset.data_sourceproperty
An optional data source id used for the specific dataset.
data_source?: string;
v1.AuxiliaryDataset.dataset_typeproperty
dataset_type: "auxiliary";
v1.AuxiliaryDataset.descriptionproperty
An optional description of the dataset.
description?: string;
v1.AuxiliaryDataset.fieldsproperty
fields?: Fields2;
v1.AuxiliaryDataset.idproperty
id: Id4;
v1.AuxiliaryDataset.precedenceproperty
precedence?: never;
v1.AuxiliaryDataset.primary_keyproperty
primary_key?: PrimaryKey2 | CompositePrimaryKey2;
v1.AuxiliaryDataset.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.AuxiliaryDataset.sqlproperty
sql?: never;
v1.AuxiliaryDataset.table_pathproperty
table_path?: never;
v1.AuxiliaryDataset.tagsproperty
tags?: Tags6;
v1.AuxiliaryDataset.titleproperty
An optional human readable title for the dataset. Will be derived from id if not provided explicitly.
title?: string;
v1.AuxiliaryDataset.typeproperty
type: "dataset";
v1.AuxiliaryDataset.workspace_data_filtersproperty
workspace_data_filters?: never;