The builder for Data
. To create a specification for certain type, use as...()
method. To create a new builder, use Spreadsheet
. To use the specification, see Data
.
Only use this class with data that's connected to a database.
This example shows how to build a BigQuery data source specification.
const spec = SpreadsheetApp . newDataSourceSpec () . asBigQuery () . setProjectId ( 'big_query_project' ) . setRawQuery ( 'select @FIELD from table limit @LIMIT' ) . setParameterFromCell ( 'FIELD' , 'Sheet1!A1' ) . setParameterFromCell ( 'LIMIT' , 'namedRangeCell' ) . build ();
This example shows how to build a Looker data source specification. It returns a Looker
object after using build()
.
const spec = SpreadsheetApp . newDataSourceSpec () . asLooker () . setInstanceUrl ( 'https://looker_instance_url.com' ) . setModelName ( 'model_name' ) . setExploreName ( 'explore_name' ) . build ();
Methods
| Method | Return type | Brief description |
|---|---|---|
Big
|
Gets the builder for BigQuery data source. | |
Looker
|
Gets the builder for Looker data source. | |
Data
|
Builds a data source specification from the settings in this builder. | |
Data
|
Creates a Data
based on this data source's settings. |
|
Data
|
Gets the parameters of the data source. | |
Data
|
Gets the type of the data source. | |
Data
|
Removes all the parameters. | |
Data
|
Removes the specified parameter. | |
Data
|
Adds a parameter, or if the parameter with the name exists, updates its source cell for data
source spec builders of type Data
. |
Detailed documentation
as
Big
Query()
Gets the builder for BigQuery data source.
Return
Big
— The BigQuery data source specification builder.
as
Looker()
Gets the builder for Looker data source.
const spec = SpreadsheetApp . newDataSourceSpec () . asLooker () . setInstanceUrl ( 'https://looker_instance_url.com' ) . setModelName ( 'model_name' ) . setExploreName ( 'explore_name' ) . build ();
Return
Looker
— The Looker data source specification builder.
build()
Builds a data source specification from the settings in this builder. Must use as...()
to specify a data source type before building.
The following code sample builds a BigQuery DataSource Spec.
const bigQueryDataSourceSpec = SpreadsheetApp . newDataSourceSpec (). asBigQuery (); // TODO(developer): Replace with the required dataset, project and table IDs. bigQueryDataSourceSpec . setDatasetId ( 'my data set id' ); bigQueryDataSourceSpec . setProjectId ( 'my project id' ); bigQueryDataSourceSpec . setTableId ( 'my table id' ); bigQueryDataSourceSpec . build ();
The following code sample builds a Looker DataSource Spec.
const lookerDataSourceSpecBuilder = SpreadsheetApp . newDataSourceSpec (). asLooker (); const lookerSpec = lookerDataSourceSpecBuilder . setExploreName ( 'my explore name' ) . setInstanceUrl ( 'my instance url' ) . setModelName ( 'my model name' ) . build ();
Return
Data
— The data source specification.
copy()
Creates a Data
based on this data source's settings.
// TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp . openByUrl ( 'https://docs.google.com/spreadsheets/d/abc123456/edit' , ); const spec = ss . getDataSources ()[ 0 ]. getSpec (); const newSpec = spec . copy ();
Return
Data
— The builder.
get
Parameters()
Gets the parameters of the data source.
// TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp . openByUrl ( 'https://docs.google.com/spreadsheets/d/abc123456/edit' , ); const spec = ss . getDataSources ()[ 0 ]. getSpec (); const parameters = spec . getParameters ();
This method is only available for BigQuery data sources.
Return
Data
— The parameter list.
get
Type()
Gets the type of the data source.
// TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp . openByUrl ( 'https://docs.google.com/spreadsheets/d/abc123456/edit' , ); const spec = ss . getDataSources ()[ 0 ]. getSpec (); const type = spec . getType ();
Return
Data
— The data source type.
remove
All
Parameters()
Removes all the parameters.
const specBuilder = SpreadsheetApp . newDataSourceSpec (); specBuilder . removeAllParameters ();
Return
Data
— The builder, for chaining.
remove
Parameter(parameterName)
Removes the specified parameter.
const specBuilder = SpreadsheetApp . newDataSourceSpec (); specBuilder . removeParameter ( 'x' );
Parameters
| Name | Type |
|---|---|
parameter
|
String
|
Description : The name of the parameter to remove. | |
Return
Data
— The builder, for chaining.
set
Parameter
From
Cell(parameterName, sourceCell)
Adds a parameter, or if the parameter with the name exists, updates its source cell for data
source spec builders of type Data
.
This method is only available for BigQuery data sources.
const specBuilder = SpreadsheetApp . newDataSourceSpec (). asBigQuery (); specBuilder . setParameterFromCell ( 'x' , 'A1' ); const bigQuerySpec = specBuilder . build ();
Parameters
| Name | Type | Description |
|---|---|---|
parameter
|
String
|
The parameter name. |
source
|
String
|
The source cell, as specified in A1 notation. |
Return
Data
— The builder, for chaining.
