> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# v1.AuxiliaryDataset

- Package: [@gooddata/sdk-code-schemas](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-code-schemas/src/v1/metadata.ts

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:**

```typescript
export interface AuxiliaryDataset 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [data\_source?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.auxiliarydataset/index.md#v1auxiliarydatasetdata_source) |  | string | _(Optional)_ An optional data source id used for the specific dataset. |
| [dataset\_type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.auxiliarydataset/index.md#v1auxiliarydatasetdataset_type) |  | "auxiliary" |  |
| [description?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.auxiliarydataset/index.md#v1auxiliarydatasetdescription) |  | string | _(Optional)_ An optional description of the dataset. |
| [fields?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.auxiliarydataset/index.md#v1auxiliarydatasetfields) |  | [Fields2](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.fields2/index.md) | _(Optional)_ |
| [id](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.auxiliarydataset/index.md#v1auxiliarydatasetid) |  | [Id4](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.id4/index.md) |  |
| [precedence?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.auxiliarydataset/index.md#v1auxiliarydatasetprecedence) |  | never | _(Optional)_ |
| [primary\_key?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.auxiliarydataset/index.md#v1auxiliarydatasetprimary_key) |  | [PrimaryKey2](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.primarykey2/index.md) \| [CompositePrimaryKey2](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.compositeprimarykey2/index.md) | _(Optional)_ |
| [references?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.auxiliarydataset/index.md#v1auxiliarydatasetreferences) |  | [Reference](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.reference/index.md)[] | _(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?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.auxiliarydataset/index.md#v1auxiliarydatasetsql) |  | never | _(Optional)_ |
| [table\_path?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.auxiliarydataset/index.md#v1auxiliarydatasettable_path) |  | never | _(Optional)_ |
| [tags?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.auxiliarydataset/index.md#v1auxiliarydatasettags) |  | [Tags6](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.tags6/index.md) | _(Optional)_ |
| [title?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.auxiliarydataset/index.md#v1auxiliarydatasettitle) |  | string | _(Optional)_ An optional human readable title for the dataset. Will be derived from id if not provided explicitly. |
| [type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.auxiliarydataset/index.md#v1auxiliarydatasettype) |  | "dataset" |  |
| [workspace\_data\_filters?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.auxiliarydataset/index.md#v1auxiliarydatasetworkspace_data_filters) |  | never | _(Optional)_ |

## Property details

### v1.AuxiliaryDataset.data_source

An optional data source id used for the specific dataset.

**Signature:**

```typescript
data_source?: string;
```

### v1.AuxiliaryDataset.dataset_type

**Signature:**

```typescript
dataset_type: "auxiliary";
```

### v1.AuxiliaryDataset.description

An optional description of the dataset.

**Signature:**

```typescript
description?: string;
```

### v1.AuxiliaryDataset.fields

**Signature:**

```typescript
fields?: Fields2;
```

### v1.AuxiliaryDataset.id

**Signature:**

```typescript
id: Id4;
```

### v1.AuxiliaryDataset.precedence

**Signature:**

```typescript
precedence?: never;
```

### v1.AuxiliaryDataset.primary_key

**Signature:**

```typescript
primary_key?: PrimaryKey2 | CompositePrimaryKey2;
```

### v1.AuxiliaryDataset.references

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.

**Signature:**

```typescript
references?: Reference[];
```

### v1.AuxiliaryDataset.sql

**Signature:**

```typescript
sql?: never;
```

### v1.AuxiliaryDataset.table_path

**Signature:**

```typescript
table_path?: never;
```

### v1.AuxiliaryDataset.tags

**Signature:**

```typescript
tags?: Tags6;
```

### v1.AuxiliaryDataset.title

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

**Signature:**

```typescript
title?: string;
```

### v1.AuxiliaryDataset.type

**Signature:**

```typescript
type: "dataset";
```

### v1.AuxiliaryDataset.workspace_data_filters

**Signature:**

```typescript
workspace_data_filters?: never;
```