Class DataSourceSpecBuilder

DataSourceSpecBuilder

Der Builder für DataSourceSpec. Verwenden Sie die Methode as...(), um eine Spezifikation für einen bestimmten Typ zu erstellen. Verwenden Sie SpreadsheetApp.newDataSourceSpec(), um einen neuen Builder zu erstellen. Informationen zur Verwendung der Spezifikation finden Sie unter DataSourceTable.

Verwenden Sie diese Klasse nur mit Daten, die mit einer Datenbank verbunden sind.

In diesem Beispiel wird gezeigt, wie Sie eine Spezifikation für eine BigQuery-Datenquelle erstellen.

var spec = SpreadsheetApp.newDataSourceSpec()
           .asBigQuery()
           .setProjectId('big_query_project')
           .setRawQuery('select @FIELD from table limit @LIMIT')
           .setParameterFromCell('FIELD', 'Sheet1!A1')
           .setParameterFromCell('LIMIT', 'namedRangeCell')
           .build();

In diesem Beispiel wird gezeigt, wie Sie eine Looker-Datenquellenspezifikation erstellen. Nach der Verwendung von build() wird ein LookerDataSourceSpec-Objekt zurückgegeben.

var spec = SpreadsheetApp.newDataSourceSpec()
           .asLooker()
           .setInstanceUrl('https://looker_instance_url.com')
           .setModelName('model_name')
           .setExploreName('explore_name')
           .build();

Methoden

MethodeRückgabetypKurzbeschreibung
asBigQuery()BigQueryDataSourceSpecBuilderRuft den Builder für die BigQuery-Datenquelle ab.
asLooker()LookerDataSourceSpecBuilderRuft den Builder für die Looker-Datenquelle ab.
build()DataSourceSpecErstellt eine Datenquellenspezifikation aus den Einstellungen in diesem Builder.
copy()DataSourceSpecBuilderErstellt auf Grundlage der Einstellungen dieser Datenquelle eine DataSourceSpecBuilder.
getParameters()DataSourceParameter[]Ruft die Parameter der Datenquelle ab.
getType()DataSourceTypeRuft den Typ der Datenquelle ab.
removeAllParameters()DataSourceSpecBuilderEntfernt alle Parameter.
removeParameter(parameterName)DataSourceSpecBuilderEntfernt den angegebenen Parameter.
setParameterFromCell(parameterName, sourceCell)DataSourceSpecBuilderFügen Sie einen Parameter hinzu oder aktualisieren Sie die Quellzelle für Datenquellenspezifikations-Builder vom Typ DataSourceType.BIGQUERY, falls der Parameter mit dem Namen bereits vorhanden ist.

Detaillierte Dokumentation

asBigQuery()

Ruft den Builder für die BigQuery-Datenquelle ab.

Rückflug

BigQueryDataSourceSpecBuilder: Der Builder für die BigQuery-Datenquellenspezifikation.


asLooker()

Ruft den Builder für die Looker-Datenquelle ab.

var spec = SpreadsheetApp.newDataSourceSpec()
           .asLooker()
           .setInstanceUrl('https://looker_instance_url.com')
           .setModelName('model_name')
           .setExploreName('explore_name')
           .build();

Rückflug

LookerDataSourceSpecBuilder: Der Builder für die Looker-Datenquellenspezifikation.


build()

Erstellt eine Datenquellenspezifikation aus den Einstellungen in diesem Builder. Muss as...() verwendet werden um vor dem Erstellen einen Datenquellentyp anzugeben.

Im folgenden Codebeispiel wird eine BigQuery-DataSource-Spezifikation erstellt.

var 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();

Im folgenden Codebeispiel wird eine Looker-Datenquellenspezifikation erstellt.

var lookerDataSourceSpecBuilder = SpreadsheetApp.newDataSourceSpec().asLooker();
var lookerSpec = lookerDataSourceSpecBuilder.setExploreName("my explore name")
                                            .setInstanceUrl("my instance url")
                                            .setModelName("my model name")
                                            .build();

Rückflug

DataSourceSpec: Datenquellenspezifikation.


copy()

Erstellt auf Grundlage der Einstellungen dieser Datenquelle eine DataSourceSpecBuilder.

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');
var spec = ss.getDataSources()[0].getSpec();

var newSpec = spec.copy();

Rückflug

DataSourceSpecBuilder: Der Builder.


getParameters()

Ruft die Parameter der Datenquelle ab.

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');
var spec = ss.getDataSources()[0].getSpec();
var parameters = spec.getParameters();

Diese Methode ist nur für BigQuery-Datenquellen verfügbar.

Rückflug

DataSourceParameter[]: Die Parameterliste.


getType()

Ruft den Typ der Datenquelle ab.

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');
var spec = ss.getDataSources()[0].getSpec();
var type = spec.getType();

Rückflug

DataSourceType: Der Typ der Datenquelle.


removeAllParameters()

Entfernt alle Parameter.

var specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeAllParameters();

Rückflug

DataSourceSpecBuilder: Der Builder für die Verkettung.


removeParameter(parameterName)

Entfernt den angegebenen Parameter.

var specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeParameter("x");

Parameter

NameTypBeschreibung
parameterNameStringDer Name des zu entfernenden Parameters.

Rückflug

DataSourceSpecBuilder: Der Builder für die Verkettung.


setParameterFromCell(parameterName, sourceCell)

Fügt einen Parameter hinzu oder, falls der Parameter mit dem Namen vorhanden ist, wird die Quellzelle für Daten aktualisiert Builder für Quellspezifikationen vom Typ DataSourceType.BIGQUERY.

Diese Methode ist nur für BigQuery-Datenquellen verfügbar.

var specBuilder = SpreadsheetApp.newDataSourceSpec().asBigQuery();
specBuilder.setParameterFromCell("x", "A1");
var bigQuerySpec = specBuilder.build();

Parameter

NameTypBeschreibung
parameterNameStringDer Parametername.
sourceCellStringQuellzelle gemäß A1-Schreibweise.

Rückflug

DataSourceSpecBuilder: Der Builder für die Verkettung.