Class DataSourceSpecBuilder

DataSourceSpecBuilder

The builder for 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 BigQuery-Datenquellenspezifikation erstellen. 

const 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. 

const 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 anhand der Einstellungen in diesem Builder.
copy()DataSourceSpecBuilderErstellt eine DataSourceSpecBuilder basierend auf den Einstellungen dieser Datenquelle.
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 BigQuery-Datenquellenspezifikations-Builder.

asLooker()

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

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

Rückflug

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

build()

Erstellt eine Datenquellenspezifikation anhand der Einstellungen in diesem Builder. Vor dem Erstellen muss mit as...() ein Datenquellentyp angegeben werden.

Im folgenden Codebeispiel wird eine BigQuery-Datenquellenspezifikation erstellt. 

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

Im folgenden Codebeispiel wird eine Looker-Datenquellenspezifikation erstellt. 

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

Rückflug

DataSourceSpec: Datenquellenspezifikation.

copy()

Erstellt eine DataSourceSpecBuilder basierend auf den Einstellungen dieser Datenquelle. 

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

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',
);
const spec = ss.getDataSources()[0].getSpec();
const parameters = spec.getParameters();

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

Rückflug

DataSourceParameter[]: 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',
);
const spec = ss.getDataSources()[0].getSpec();
const type = spec.getType();

Rückflug

DataSourceType: Der Datenquellentyp.

removeAllParameters()

Entfernt alle Parameter. 

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

Rückflug

DataSourceSpecBuilder – Der Builder zur Verkettung.

removeParameter(parameterName)

Entfernt den angegebenen Parameter. 

const specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeParameter('x');

Parameter

NameTypBeschreibung
parameterNameStringDer Name des zu entfernenden Parameters.

Rückflug

DataSourceSpecBuilder – Der Builder zur Verkettung.

setParameterFromCell(parameterName, sourceCell)

Fü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.

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

const specBuilder = SpreadsheetApp.newDataSourceSpec().asBigQuery();
specBuilder.setParameterFromCell('x', 'A1');
const bigQuerySpec = specBuilder.build();

Parameter

NameTypBeschreibung
parameterNameStringDer Parametername.
sourceCellStringDie Quellzelle in A1-Notation.

Rückflug

DataSourceSpecBuilder – Der Builder zur Verkettung.