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

Class DataSource

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

DataSource

Access and modify existing data source. To create a data source table with new data source, see[DataSourceTable](/apps-script/reference/spreadsheet/data-source-table).

Only use this class with data that's connected to a database.

Methods

Method Return type Brief description
cancelAllLinkedDataSourceObjectRefreshes() void Cancels all currently running refreshes of data source objects linked to this data source.
createCalculatedColumn(name, formula) DataSourceColumn Creates a calculated column.
createDataSourcePivotTableOnNewSheet() DataSourcePivotTable Creates a data source pivot table from this data source in the first cell of a new sheet.
createDataSourceTableOnNewSheet() DataSourceTable Creates a data source table from this data source in the first cell of a new sheet.
getCalculatedColumnByName(columnName) DataSourceColumn Returns the calculated column in the data source that matches the column name.
getCalculatedColumns() DataSourceColumn[] Returns all the calculated columns in the data source.
getColumns() DataSourceColumn[] Returns all the columns in the data source.
getDataSourceSheets() DataSourceSheet[] Returns the data source sheets associated with this data source.
getSpec() DataSourceSpec Gets the data source specification.
refreshAllLinkedDataSourceObjects() void Refreshes all data source objects linked to the data source.
updateSpec(spec) DataSource Updates the data source specification and refreshes the data source objects linked with this data source with the new specification.
updateSpec(spec, refreshAllLinkedObjects) DataSource Updates the data source specification and refreshes the linked data source sheets with the new specification.
waitForAllDataExecutionsCompletion(timeoutInSeconds) void Waits until all the current executions of the linked data source objects complete, timing out after the provided number of seconds.

Detailed documentation

cancelAllLinkedDataSourceObjectRefreshes()

Cancels all currently running refreshes of data source objects linked to this data source.

This example shows how to cancel all the refreshes of a data source.

SpreadsheetApp.enableBigQueryExecution(); const spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); const dataSource = spreadsheet.getDataSources()[0]; dataSource.cancelAllLinkedDataSourceObjectRefreshes();

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

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

createCalculatedColumn(name, formula)

Creates a calculated column. This method is only available for BigQuery data sources.

Parameters

Name Type Description
name String The name of the calculated column.
formula String The calculated column formula.

Return

[DataSourceColumn](/apps-script/reference/spreadsheet/data-source-column) — The newly created calculated column.

Authorization

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

createDataSourcePivotTableOnNewSheet()

Creates a data source pivot table from this data source in the first cell of a new sheet. As a side effect, makes the new sheet the active sheet.

Return

[DataSourcePivotTable](/apps-script/reference/spreadsheet/data-source-pivot-table) — The newly created data source pivot table.

Authorization

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

createDataSourceTableOnNewSheet()

Creates a data source table from this data source in the first cell of a new sheet. As a side effect, makes the new sheet the active sheet.

This method is only available for BigQuery data sources.

Return

[DataSourceTable](/apps-script/reference/spreadsheet/data-source-table) — The newly created data source table.

Authorization

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

getCalculatedColumnByName(columnName)

Returns the calculated column in the data source that matches the column name.

Parameters

Name Type Description
columnName String The name of the calculated column to get.

Return

[DataSourceColumn](/apps-script/reference/spreadsheet/data-source-column) — The calculated column that matches the column name, or null if there is no such calculated column.

Authorization

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

getCalculatedColumns()

Returns all the calculated columns in the data source.

Data source specs of [DataSourceType.LOOKER](/apps-script/reference/spreadsheet/data-source-type#LOOKER) type returns an empty array.

Return

[DataSourceColumn[]](/apps-script/reference/spreadsheet/data-source-column) — An array of all the calculated columns in the data source.

Authorization

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

getColumns()

Returns all the columns in the data source.

Return

[DataSourceColumn[]](/apps-script/reference/spreadsheet/data-source-column) — An array of all the [DataSourceColumn](/apps-script/reference/spreadsheet/data-source-column) in the data source.

Authorization

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

getDataSourceSheets()

Returns the data source sheets associated with this data source.

Return

[DataSourceSheet[]](/apps-script/reference/spreadsheet/data-source-sheet) — An array of data source sheets.

Authorization

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

getSpec()

Gets the data source specification.

Return

[DataSourceSpec](/apps-script/reference/spreadsheet/data-source-spec) — The data source specification.

Authorization

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

refreshAllLinkedDataSourceObjects()

Refreshes all data source objects linked to the data source.

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

Authorization

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

updateSpec(spec)

Updates the data source specification and refreshes the data source objects linked with this data source with the new specification.

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

Throws an exception if the data source specification type is of a different type than the current data source type.

Parameters

Name Type Description
spec DataSourceSpec The data source specification to update with.

Return

[DataSource](#) — The data source.

Authorization

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

updateSpec(spec, refreshAllLinkedObjects)

Updates the data source specification and refreshes the linked [data source sheets](/apps-script/reference/spreadsheet/data-source-sheet) with the new specification.

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

Throws an exception if the data source specification type is of a different type than the current data source type.

Parameters

Name Type Description
spec DataSourceSpec The data source specification to update with.
refreshAllLinkedObjects Boolean If true, also refreshes all the data source objects linked with this data source.

Return

[DataSource](#) — The data source.

Authorization

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Waits until all the current executions of the linked data source objects complete, timing out after the provided number of seconds. Throws an exception if the executions are not completed when timing out, but does not cancel the data executions.

Parameters

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

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.