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. Es gibt ein LookerDataSourceSpec-Objekt zurück, nachdem build() verwendet wurde.

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

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
asBigQuery()	BigQueryDataSourceSpecBuilder	Gibt den Builder für die BigQuery-Datenquelle zurück.
asLooker()	LookerDataSourceSpecBuilder	Gibt den Builder für die Looker-Datenquelle zurück.
build()	DataSourceSpec	Erstellt eine Datenquellenspezifikation anhand der Einstellungen in diesem Builder.
copy()	DataSourceSpecBuilder	Erstellt ein DataSourceSpecBuilder basierend auf den Einstellungen dieser Datenquelle.
getParameters()	DataSourceParameter[]	Ruft die Parameter der Datenquelle ab.
getType()	DataSourceType	Ruft den Typ der Datenquelle ab.
removeAllParameters()	DataSourceSpecBuilder	Entfernt alle Parameter.
removeParameter(parameterName)	DataSourceSpecBuilder	Entfernt den angegebenen Parameter.
setParameterFromCell(parameterName, sourceCell)	DataSourceSpecBuilder	Fügt einen Parameter hinzu. Wenn der Parameter mit dem Namen bereits vorhanden ist, wird die Quellzelle für Datenquellen-Spezifikationsgeneratoren vom Typ DataSourceType.BIGQUERY aktualisiert.

Detaillierte Dokumentation

asBigQuery()

Gibt den Builder für die BigQuery-Datenquelle zurück.

Rückflug

BigQueryDataSourceSpecBuilder: Der Builder für die Spezifikation der BigQuery-Datenquelle.

---

asLooker()

Gibt den Builder für die Looker-Datenquelle zurück.

const 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 anhand der Einstellungen in diesem Builder. Sie müssen as...() verwenden, um vor dem Erstellen einen Datenquellentyp anzugeben.

Im folgenden Codebeispiel wird eine BigQuery-DataSource-Spezifikation 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: Die Datenquellenspezifikation.

---

copy()

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

Rückflug

DataSourceType: Der Typ der Datenquelle.

---

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

Name	Typ	Beschreibung
parameterName	String	Der Name des zu entfernenden Parameters.

Rückflug

DataSourceSpecBuilder – Der Builder zur Verkettung.

---

setParameterFromCell(parameterName, sourceCell)

Fügt einen Parameter hinzu. Wenn der Parameter mit dem Namen bereits vorhanden ist, wird die Quellzelle für Datenquellen-Spezifikationsgeneratoren vom Typ DataSourceType.BIGQUERY aktualisiert.

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

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

Parameter

Name	Typ	Beschreibung
parameterName	String	Der Parametername.
sourceCell	String	Die Quellzelle, wie in der A1-Notation angegeben.

Rückflug

DataSourceSpecBuilder – Der Builder zur Verkettung.