GoodData.UI API reference
  • All Products
  • All Products
  • GoodData.UI
  • API Reference
  • University
  • Community
  • Documentation
  • Support
  • 11.34.0
  • Code samples
  • GitHub

AuxiliaryDataset

Home > @gooddata/sdk-code-schemas > v1 > AuxiliaryDataset

v1.AuxiliaryDataset interface

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.

Signature:

export interface AuxiliaryDataset 

Properties

Property

Modifiers

Type

Description

data_source?

string

(Optional) An optional data source id used for the specific dataset.

dataset_type

"auxiliary"

description?

string

(Optional) An optional description of the dataset.

fields?

Fields2

(Optional)

id

Id4

precedence?

never

(Optional)

primary_key?

PrimaryKey2 | CompositePrimaryKey2

(Optional)

references?

Reference[]

(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.

sql?

never

(Optional)

table_path?

never

(Optional)

tags?

Tags6

(Optional)

title?

string

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

type

"dataset"

workspace_data_filters?

never

(Optional)

  • v1.AuxiliaryDataset interface
  • Properties
GoodData resources:
  • Documentation
Follow the community:
  • Community
Copyright © 2007–2026 GoodData Corporation. All Rights Reserved. Code licensed under a dual license - CC BY‑NC 4.0 for trial experience and GoodData.UI EULA for commercial use