Class DataSourceTable  |  Apps Script  |  Google for Developers (original) (raw)

Class DataSourceTable

Stay organized with collections Save and categorize content based on your preferences.

DataSourceTable

Access and modify existing data source table. To create a new data source table on a new sheet, use [Spreadsheet.insertSheetWithDataSourceTable(spec)](/apps-script/reference/spreadsheet/spreadsheet#insertSheetWithDataSourceTable%28DataSourceSpec%29).

Only use this class with BigQuery data sources.

This example shows how to create a new data source table.

SpreadsheetApp.enableBigQueryExecution(); const spreadsheet = SpreadsheetApp.getActive(); const spec = SpreadsheetApp.newDataSourceSpec() .asBigQuery() .setProjectId('big_query_project') .setRawQuery('select @FIELD from table limit @LIMIT') .setParameterFromCell('FIELD', 'Sheet1!A1') .setParameterFromCell('LIMIT', 'namedRangeCell') .build(); // Starts data execution asynchronously. const dataSheet = spreadsheet.insertSheetWithDataSourceTable(spec); const dataSourceTable = dataSheet.getDataSourceTables()[0]; // waitForCompletion() blocks script execution until data execution completes. dataSourceTable.waitForCompletion(60); // Check status after execution. Logger.log( 'Data execution state: %s.', dataSourceTable.getStatus().getExecutionState(), );

This example shows how to edit a data source.

SpreadsheetApp.enableBigQueryExecution(); const dataSheet = SpreadsheetApp.getActive().getSheetByName('Data Sheet 1'); const dataSourceTable = dataSheet.getDataSourceTables()[0]; const dataSource = dataSourceTable.getDataSource(); const newSpec = dataSource.getSpec() .copy() .asBigQuery() .setRawQuery('select name from table limit 2') .removeAllParameters() .build(); // Updates data source specification and starts data execution asynchronously. dataSource.updateSpec(newSpec); // Check status during execution. Logger.log( 'Data execution state: %s.', dataSourceTable.getStatus().getExecutionState(), ); // waitForCompletion() blocks script execution until data execution completes. dataSourceTable.waitForCompletion(60); // Check status after execution. Logger.log( 'Data execution state: %s.', dataSourceTable.getStatus().getExecutionState(), );

Detailed documentation

addColumns(columnNames)

Adds columns to the data source table.

Parameters

Name Type Description
columnNames String[] The list of the names of the columns to add.

Return

[DataSourceTable](#) — The data source table, for chaining.

Scripts that use this method require authorization with one or more of the following scopes:

addFilter(columnName, filterCriteria)

Adds a filter applied to the data source table.

Parameters

Name Type Description
columnName String The name of the column to apply this filter to.
filterCriteria FilterCriteria The filter criteria to apply.

Return

[DataSourceTable](#) — The data source table, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

addSortSpec(columnName, ascending)

Adds a sort spec on a column in the data source table.

Parameters

Name Type Description
columnName String The name of the column to sort.
ascending Boolean If true, sort the column in ascending order; if false, sort the column in descending order.

Return

[DataSourceTable](#) — The data source sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

addSortSpec(columnName, sortOrder)

Adds a sort spec on a column in the data source table.

Parameters

Name Type Description
columnName String The name of the column to sort.
sortOrder SortOrder The sort order.

Return

[DataSourceTable](#) — The data source sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

cancelDataRefresh()

Cancels the data refresh associated with this object if it's currently running.

This example shows how to cancel a formula refresh.

const spreadsheet = SpreadsheetApp.getActive(); const formula = spreadsheet.getDataSourceFormulas()[0]; // Cancel the ongoing refresh on the formula. formula.cancelDataRefresh();

Throws an exception if the data source type is not enabled. Use SpreadsheetApp#enable...Execution() methods to enable data execution for specific data source type.

Return

[DataSourceTable](#) — The data object.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

forceRefreshData()

Refreshes the data of this object regardless of the current state. See [refreshData()](#refreshData%28%29) for more details. If you want to cancel a currently running refresh of this object, see [cancelDataRefresh()](#cancelDataRefresh%28%29).

Throws an exception if the data source type is not enabled. Use SpreadsheetApp#enable...Execution() methods to enable data execution for specific data source type.

Return

[DataSourceTable](#) — The data object.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getColumns()

Gets all the data source columns added to the data source table.

Return

[DataSourceTableColumn[]](/apps-script/reference/spreadsheet/data-source-table-column) — A list of data source table columns.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getDataSource()

Gets the data source the object is linked to.

Return

[DataSource](/apps-script/reference/spreadsheet/data-source) — The data source.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getFilters()

Returns all filters applied to the data source table.

Return

[DataSourceTableFilter[]](/apps-script/reference/spreadsheet/data-source-table-filter) — An array of all filters applied to the data source table.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getRange()

Gets the [Range](/apps-script/reference/spreadsheet/range) this data source table spans.

Return

[Range](/apps-script/reference/spreadsheet/range) — The range.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getRowLimit()

Returns the row limit for the data source table.

Return

Integer — The row limit for the data source table, or null if no limit is set and the table uses the default max limit as in Google Sheets UI.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getSortSpecs()

Gets all the sort specs in the data source table.

Return

[SortSpec[]](/apps-script/reference/spreadsheet/sort-spec) — A list of sort specs.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

getStatus()

Gets the data execution status of the object.

Return

[DataExecutionStatus](/apps-script/reference/spreadsheet/data-execution-status) — The data execution status.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

isSyncingAllColumns()

Returns whether the data source table is syncing all columns in the associated data source.

Return

Boolean — True if the data source table is syncing all columns in the associated data source, or false otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

refreshData()

Refreshes the data of the object.

Throws an exception if currently in [error](/apps-script/reference/spreadsheet/data-execution-state#ERROR) state. Use [DataSource#updateSpec()](/apps-script/reference/spreadsheet/data-source#updateSpec%28DataSourceSpec%29) to update the specification. The method is preferred over [forceRefreshData()](#forceRefreshData%28%29) to prevent unexpected edits on data source.

Throws an exception if the data source type is not enabled. Use SpreadsheetApp#enable...Execution() methods to enable data execution for specific data source type.

Return

[DataSourceTable](#) — The data object.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

removeAllColumns()

Removes all the columns in the data source table.

Return

[DataSourceTable](#) — The data source table, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

removeAllSortSpecs()

Removes all the sort specs in the data source table.

Return

[DataSourceTable](#) — The data source sheet, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

setRowLimit(rowLimit)

Updates the row limit for the data source table. If the provided row limit is null, then updates the data source table to use the default max row limit as in Google Sheets UI.

Parameters

Name Type Description
rowLimit Integer The new row limit for the data table. If null, updates the table to use the default row limit.

Return

[DataSourceTable](#) — The data source table, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

syncAllColumns()

Sync all current and future columns in the associated data source to the data source table.

Return

[DataSourceTable](#) — The data source table, for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

waitForCompletion(timeoutInSeconds)

Waits until the current execution completes, timing out after the provided number of seconds. Throws an exception if the execution is not completed when timing out, but does not cancel the data execution.

Parameters

Name Type Description
timeoutInSeconds Integer The time to wait for data execution, in seconds. The maximum is 300 seconds.

Return

[DataExecutionStatus](/apps-script/reference/spreadsheet/data-execution-status) — The data execution status.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-12-03 UTC.