---
schema_version: "1"
id: cbed1bccf5616589dcf0bcc5dc01fec4c15381363f2e4a2a8443222f5d4199bf
title: DataSourceUnderlyingDataOptions | Tableau Embedding API
collection: tableau
version: current
locale: en-us
portal_url: https://docs.salesforce.com/tableau/current/en-us/api/embedding_api/reference/interfaces/DataSourceUnderlyingDataOptions.md
canonical_url: https://help.tableau.com/current/api/embedding_api/en-us/reference/interfaces/DataSourceUnderlyingDataOptions.html
source_site: help.tableau.com
content_type: documentation
content_hash: 2ed83fabf583cce50d0b3c1daae853118a8fbd3fa42a136f38bc602636cb89e6
description: Documentation for Tableau Embedding API
---
- DataSourceUnderlyingDataOptions

# Interface DataSourceUnderlyingDataOptions

Configuration object for fetching data from an data source object.

interface DataSourceUnderlyingDataOptions {  
    [columnsToInclude](#columnstoinclude)?: string\[\];  
    [columnsToIncludeById](#columnstoincludebyid)?: string\[\];  
    [ignoreAliases](#ignorealiases)?: boolean;  
    [includeDataValuesOption](#includedatavaluesoption)?: [IncludeDataValuesOption](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/IncludeDataValuesOption.html);  
    [maxRows](#maxrows)?: number;  
}

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:352

##### Index

### Properties

[columnsToInclude?](#columnstoinclude) [columnsToIncludeById?](#columnstoincludebyid) [ignoreAliases?](#ignorealiases) [includeDataValuesOption?](#includedatavaluesoption) [maxRows?](#maxrows)

## Properties

### `Optional`columnsToInclude[](#columnstoinclude)

columnsToInclude?: string\[\]

The columns to return specified by field name, returns all by default.

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:361

### `Optional`columnsToIncludeById[](#columnstoincludebyid)

columnsToIncludeById?: string\[\]

The columns to return specified by field id, returns all by default. Since 1.5.0, fieldId is a property of the Column object.

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:369

### `Optional`ignoreAliases[](#ignorealiases)

ignoreAliases?: boolean

Do not use aliases specified in the data source in Tableau. Default is false.

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:356

### `Optional`includeDataValuesOption[](#includedatavaluesoption)

includeDataValuesOption?: [IncludeDataValuesOption](https://help.tableau.com/current/api/embedding_api/en-us/reference/enums/IncludeDataValuesOption.html)

Specify which properties to return in DataValues. The default is `IncludeDataValuesOption.AllValues`. All properties not requested will be `undefined` in the DataValue results. This is a performance optimization only, and will be ignored in Tableau versions prior to 2021.2.

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:385

### `Optional`maxRows[](#maxrows)

maxRows?: number

The maximum number of rows to return. 10,000 by default

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:376

### Settings

Member Visibility

- Protected
- Inherited
- External

ThemeOSLightDark

### On This Page

Properties

[columnsToInclude](#columnstoinclude)[columnsToIncludeById](#columnstoincludebyid)[ignoreAliases](#ignorealiases)[includeDataValuesOption](#includedatavaluesoption)[maxRows](#maxrows)