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

# v1.Attribute

- 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

**Signature:**

```typescript
export interface Attribute 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [data\_type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.attribute/index.md#v1attributedata_type) |  | "INT" \| "STRING" \| "DATE" \| "NUMERIC" \| "TIMESTAMP" \| "TIMESTAMP\_TZ" \| "BOOLEAN" \| "HLL" | A column data type in the physical database. |
| [default\_view?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.attribute/index.md#v1attributedefault_view) |  | string | _(Optional)_ An Id of the label to be used by default for this field |
| [description?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.attribute/index.md#v1attributedescription) |  | string | _(Optional)_ An optional description of the field. |
| [is\_hidden?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.attribute/index.md#v1attributeis_hidden) |  | boolean | _(Optional)_ |
| [is\_nullable?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.attribute/index.md#v1attributeis_nullable) |  | boolean | _(Optional)_ Optional flag to indicate if the attribute can contain null values. |
| [labels?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.attribute/index.md#v1attributelabels) |  | { [k: string]: [Label](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.label/index.md); } | _(Optional)_ |
| [locale?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.attribute/index.md#v1attributelocale) |  | [Locale](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.locale/index.md) | _(Optional)_ |
| [null\_value\_join\_replacement?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.attribute/index.md#v1attributenull_value_join_replacement) |  | string | _(Optional)_ Optional value which can be used as replacement for NULL in join conditions. |
| [show\_in\_ai\_results?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.attribute/index.md#v1attributeshow_in_ai_results) |  | boolean | _(Optional)_ Optional flag to indicate if the attribute should be shown in AI results. When omitted, the attribute is visible. |
| [sort\_column?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.attribute/index.md#v1attributesort_column) |  | string | _(Optional)_ A column name in the source table to do sorting by |
| [sort\_direction?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.attribute/index.md#v1attributesort_direction) |  | "ASC" \| "DESC" | _(Optional)_ |
| [source\_column?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.attribute/index.md#v1attributesource_column) |  | string | _(Optional)_ A column name in the physical database. Optional, equals to id by default. |
| [tags?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.attribute/index.md#v1attributetags) |  | [Tags1](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.tags1/index.md) | _(Optional)_ |
| [title?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.attribute/index.md#v1attributetitle) |  | string | _(Optional)_ A human readable title of the field. Optional, 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.attribute/index.md#v1attributetype) |  | "attribute" |  |

## Property details

### v1.Attribute.data_type

A column data type in the physical database.

**Signature:**

```typescript
data_type: "INT" | "STRING" | "DATE" | "NUMERIC" | "TIMESTAMP" | "TIMESTAMP_TZ" | "BOOLEAN" | "HLL";
```

### v1.Attribute.default_view

An Id of the label to be used by default for this field

**Signature:**

```typescript
default_view?: string;
```

### v1.Attribute.description

An optional description of the field.

**Signature:**

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

### v1.Attribute.is_hidden

> Warning: This API is now obsolete.
> 
> Deprecated. Use 'show\_in\_ai\_results' instead.
> 

**Signature:**

```typescript
is_hidden?: boolean;
```

### v1.Attribute.is_nullable

Optional flag to indicate if the attribute can contain null values.

**Signature:**

```typescript
is_nullable?: boolean;
```

### v1.Attribute.labels

**Signature:**

```typescript
labels?: {
        [k: string]: Label;
    };
```

### v1.Attribute.locale

**Signature:**

```typescript
locale?: Locale;
```

### v1.Attribute.null_value_join_replacement

Optional value which can be used as replacement for NULL in join conditions.

**Signature:**

```typescript
null_value_join_replacement?: string;
```

### v1.Attribute.show_in_ai_results

Optional flag to indicate if the attribute should be shown in AI results. When omitted, the attribute is visible.

**Signature:**

```typescript
show_in_ai_results?: boolean;
```

### v1.Attribute.sort_column

A column name in the source table to do sorting by

**Signature:**

```typescript
sort_column?: string;
```

### v1.Attribute.sort_direction

**Signature:**

```typescript
sort_direction?: "ASC" | "DESC";
```

### v1.Attribute.source_column

A column name in the physical database. Optional, equals to id by default.

**Signature:**

```typescript
source_column?: string;
```

### v1.Attribute.tags

**Signature:**

```typescript
tags?: Tags1;
```

### v1.Attribute.title

A human readable title of the field. Optional, derived from id if not provided explicitly.

**Signature:**

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

### v1.Attribute.type

**Signature:**

```typescript
type: "attribute";
```