Class BigQueryDataSourceSpec
Stay organized with collections
Save and categorize content based on your preferences.
AI-generated Key Takeaways
-
BigQueryDataSourceSpec allows access to existing BigQuery data source specifications within SpreadsheetApp.
-
You can create a new data source specification using SpreadsheetApp.newDataSourceSpec().
-
The methods available include retrieving dataset ID, parameters, project ID, raw query, table ID, table project ID, and data source type.
-
The copy() method creates a DataSourceSpecBuilder based on the existing data source's settings.
Access the existing BigQuery data source specification. To create a new data source
specification, use Spreadsheet.
Methods
| Method | Return type | Brief description |
|---|---|---|
copy() | Data | Creates a Data based on this data source's settings. |
get | String | Gets the BigQuery dataset ID. |
get | Data | Gets the parameters of the data source. |
get | String | Gets the billing project ID. |
get | String | Gets the raw query string. |
get | String | Gets the BigQuery table ID. |
get | String | Gets the BigQuery project ID for the table. |
get | Data | Gets the type of the data source. |
Detailed documentation
copy()
Creates a Data based on this data source's settings.
// TODO(developer): Replace the URL with your own. constss=SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); constspec=ss.getDataSources()[0].getSpec(); constnewSpec=spec.copy();
Return
Data — The builder.
getDatasetId()
Gets the BigQuery dataset ID.
Return
String — The dataset ID, or an empty string if the data source spec is defined by a raw query.
getParameters()
Gets the parameters of the data source.
// TODO(developer): Replace the URL with your own. constss=SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); constspec=ss.getDataSources()[0].getSpec(); constparameters=spec.getParameters();
This method is only available for BigQuery data sources.
Return
Data — The parameter list.
getProjectId()
Gets the billing project ID.
Return
String — The project ID.
getRawQuery()
Gets the raw query string.
Return
String — The raw query string.
getTableId()
Gets the BigQuery table ID.
Return
String — The table ID, or an empty string if the data source spec is defined by a raw query.
getTableProjectId()
Gets the BigQuery project ID for the table.
Return
String — The table project ID, or an empty string if the data source spec is defined by a raw
query.
getType()
Gets the type of the data source.
// TODO(developer): Replace the URL with your own. constss=SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); constspec=ss.getDataSources()[0].getSpec(); consttype=spec.getType();
Return
Data — The data source type.