Class DataSourceFormula
Stay organized with collections
Save and categorize content based on your preferences.
AI-generated Key Takeaways
-
Use DataSourceFormula to access and modify existing data source formulas, but use Range.setFormula(formula) to create a new one.
-
This class is specifically for data connected to a BigQuery database.
-
Methods are available to cancel, force, or simply refresh data, get information about the formula and its status, and set a new formula.
-
Scripts using these methods require specific authorization scopes related to spreadsheets.
Access and modify existing data source formulas. To create a new data source formula, use Range.setFormula(formula) .
Only use this class with data that's connected to a BigQuery database.
Methods
| Method | Return type | Brief description |
|---|---|---|
cancel | Data | Cancels the data refresh associated with this object if it's currently running. |
force | Data | Refreshes the data of this object regardless of the current state. |
get | Range | Returns the Range representing the cell where this data source formula is anchored. |
get | Data | Gets the data source the object is linked to. |
get | String | Returns the display value of the data source formula. |
get | String | Returns the formula for this data source formula. |
get | Data | Gets the data execution status of the object. |
refresh | Data | Refreshes the data of the object. |
set | Data | Updates the formula. |
wait | Data | Waits until the current execution completes, timing out after the provided number of seconds. |
Detailed documentation
cancelDataRefresh()
Cancels the data refresh associated with this object if it's currently running.
This example shows how to cancel a formula refresh.
constspreadsheet=SpreadsheetApp.getActive(); constformula=spreadsheet.getDataSourceFormulas()[0]; // Cancel the ongoing refresh on the formula. formula.cancelDataRefresh();
Throws an exception if the data source type is not enabled. Use Spreadsheet methods to enable data execution for specific data source
type.
Return
Data — The data object.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
Refreshes the data of this object regardless of the current state. See refresh for
more details. If you want to cancel a currently running refresh of this object, see cancel.
Throws an exception if the data source type is not enabled. Use Spreadsheet methods to enable data execution for specific data source
type.
Return
Data — The data object.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getAnchorCell()
Returns the Range representing the cell where this data source formula is anchored.
Return
Range — The anchor cell.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getDataSource()
Gets the data source the object is linked to.
Return
Data — The data source.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getDisplayValue()
Returns the display value of the data source formula.
Return
String — The display value.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFormula()
Returns the formula for this data source formula.
Return
String — The formula.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getStatus()
Gets the data execution status of the object.
Return
Data — The data execution status.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
refreshData()
Refreshes the data of the object.
Throws an exception if currently in error state. Use Data to update the specification. The method is
preferred over force to prevent unexpected edits on data source.
Throws an exception if the data source type is not enabled. Use Spreadsheet methods to enable data execution for specific data source
type.
Return
Data — The data object.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
setFormula(formula)
Updates the formula.
Parameters
| Name | Type | Description |
|---|---|---|
formula | String | The new formula. |
Return
Data — The data source formula, for chaining.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
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 |
|---|---|---|
timeout | Integer | The time to wait for data execution, in seconds. The maximum is 300 seconds. |
Return
Data — The data execution status.
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets