Class DataSource

Datenquelle

Auf bestehende Datenquellen zugreifen und diese bearbeiten Informationen zum Erstellen einer Datenquellentabelle mit einer neuen Datenquelle finden Sie unter DataSourceTable.

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

Methoden

MethodeRückgabetypKurzbeschreibung
cancelAllLinkedDataSourceObjectRefreshes()voidBricht alle aktuell laufenden Aktualisierungen von Datenquellenobjekten ab, die mit dieser Datenquelle verknüpft sind.
createCalculatedColumn(name, formula)DataSourceColumnErstellt eine berechnete Spalte.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableErstellt in der ersten Zelle eines neuen Tabellenblatts eine Pivot-Tabelle für die Datenquelle.
createDataSourceTableOnNewSheet()DataSourceTableErstellt in der ersten Zelle eines neuen Tabellenblatts eine Datenquellentabelle aus dieser Datenquelle.
getCalculatedColumnByName(columnName)DataSourceColumn|nullGibt die berechnete Spalte in der Datenquelle zurück, die mit dem Spaltennamen übereinstimmt.
getCalculatedColumns()DataSourceColumn[]Gibt alle berechneten Spalten in der Datenquelle zurück.
getColumns()DataSourceColumn[]Gibt alle Spalten in der Datenquelle zurück.
getDataSourceSheets()DataSourceSheet[]Gibt die Datenquellenblätter zurück, die dieser Datenquelle zugeordnet sind.
getSpec()DataSourceSpecRuft die Datenquellenspezifikation ab.
refreshAllLinkedDataSourceObjects()voidAlle Datenquellenobjekte, die mit der Datenquelle verknüpft sind, werden aktualisiert.
updateSpec(spec)DataSourceAktualisiert die Datenquellenspezifikation und aktualisiert die mit dieser Datenquelle verknüpften Datenquellenobjekte mit der neuen Spezifikation.
updateSpec(spec, refreshAllLinkedObjects)DataSourceAktualisiert die Datenquellenspezifikation und aktualisiert die verknüpften data source sheets mit der neuen Spezifikation.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidWartet, bis alle aktuellen Ausführungen der verknüpften Datenquellenobjekte abgeschlossen sind. Das Zeitlimit wird nach der angegebenen Anzahl von Sekunden überschritten.

Detaillierte Dokumentation

cancelAllLinkedDataSourceObjectRefreshes()

Bricht alle aktuell laufenden Aktualisierungen von Datenquellenobjekten ab, die mit dieser Datenquelle verknüpft sind.

In diesem Beispiel wird gezeigt, wie Sie alle Aktualisierungen einer Datenquelle abbrechen. 

SpreadsheetApp.enableBigQueryExecution();
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const dataSource = spreadsheet.getDataSources()[0];
dataSource.cancelAllLinkedDataSourceObjectRefreshes();

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Verwenden Sie SpreadsheetApp#enable...Execution()-Methoden, um die Datenabfrage für den jeweiligen Datenquellentyp zu aktivieren.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

createCalculatedColumn(name, formula)

Erstellt eine berechnete Spalte. Diese Methode ist nur für BigQuery-Datenquellen verfügbar.

Parameter

NameTypBeschreibung
nameStringDer Name der berechneten Spalte.
formulaStringDie Formel für die berechnete Spalte.

Rückflug

DataSourceColumn: Die neu erstellte berechnete Spalte.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

createDataSourcePivotTableOnNewSheet()

Erstellt in der ersten Zelle eines neuen Tabellenblatts eine Pivot-Tabelle für die Datenquelle. Als Nebeneffekt wird das neue Tabellenblatt zum aktiven Tabellenblatt.

Rückflug

DataSourcePivotTable: Die neu erstellte Pivot-Tabelle für die Datenquelle.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

createDataSourceTableOnNewSheet()

Erstellt in der ersten Zelle eines neuen Tabellenblatts eine Datenquellentabelle aus dieser Datenquelle. Dadurch wird das neue Tabellenblatt zum aktiven Tabellenblatt.

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

Rückflug

DataSourceTable: Die neu erstellte Datenquellentabelle.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getCalculatedColumnByName(columnName)

Gibt die berechnete Spalte in der Datenquelle zurück, die mit dem Spaltennamen übereinstimmt.

Parameter

NameTypBeschreibung
columnNameStringDer Name der berechneten Spalte, die abgerufen werden soll.

Rückflug

DataSourceColumn|null: Die berechnete Spalte, die dem Spaltennamen entspricht, oder null, wenn es keine solche berechnete Spalte gibt.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getCalculatedColumns()

Gibt alle berechneten Spalten in der Datenquelle zurück.

Datenquellenspezifikationen vom Typ DataSourceType.LOOKER geben ein leeres Array zurück.

Rückflug

DataSourceColumn[]: Ein Array mit allen berechneten Spalten in der Datenquelle.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getColumns()

Gibt alle Spalten in der Datenquelle zurück.

Rückflug

DataSourceColumn[]: Ein Array mit allen DataSourceColumn in der Datenquelle.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSourceSheets()

Gibt die Datenquellenblätter zurück, die dieser Datenquelle zugeordnet sind.

Rückflug

DataSourceSheet[]: Ein Array von Datenquellen-Tabellenblättern.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSpec()

Ruft die Datenquellenspezifikation ab.

Rückflug

DataSourceSpec: Die Datenquellenspezifikation.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

refreshAllLinkedDataSourceObjects()

Alle Datenquellenobjekte, die mit der Datenquelle verknüpft sind, werden aktualisiert.

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Verwenden Sie SpreadsheetApp#enable...Execution()-Methoden, um die Datenabfrage für den jeweiligen Datenquellentyp zu aktivieren.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

updateSpec(spec)

Aktualisiert die Datenquellenspezifikation und aktualisiert die mit dieser Datenquelle verknüpften Datenquellenobjekte mit der neuen Spezifikation.

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Verwenden Sie SpreadsheetApp#enable...Execution()-Methoden, um die Datenabfrage für den jeweiligen Datenquellentyp zu aktivieren.

Löst eine Ausnahme aus, wenn der Typ der Datenquellenspezifikation nicht mit dem aktuellen Datenquellentyp übereinstimmt.

Parameter

NameTypBeschreibung
specDataSourceSpecDie Datenquellenspezifikation, mit der die Datenquelle aktualisiert werden soll.

Rückflug

DataSource: Die Datenquelle.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

updateSpec(spec, refreshAllLinkedObjects)

Aktualisiert die Datenquellenspezifikation und aktualisiert die verknüpften data source sheets mit der neuen Spezifikation.

Löst eine Ausnahme aus, wenn der Datenquellentyp nicht aktiviert ist. Verwenden Sie SpreadsheetApp#enable...Execution()-Methoden, um die Datenabfrage für den jeweiligen Datenquellentyp zu aktivieren.

Löst eine Ausnahme aus, wenn der Typ der Datenquellenspezifikation nicht mit dem aktuellen Datenquellentyp übereinstimmt.

Parameter

NameTypBeschreibung
specDataSourceSpecDie Datenquellenspezifikation, mit der die Datenquelle aktualisiert werden soll.
refreshAllLinkedObjectsBooleanWenn true, werden auch alle Datenquellenobjekte aktualisiert, die mit dieser Datenquelle verknüpft sind.

Rückflug

DataSource: Die Datenquelle.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Wartet, bis alle aktuellen Ausführungen der verknüpften Datenquellenobjekte abgeschlossen sind. Das Zeitlimit wird nach der angegebenen Anzahl von Sekunden überschritten. Löst eine Ausnahme aus, wenn die Ausführungen bei Zeitüberschreitung nicht abgeschlossen sind, bricht die Datenausführungen jedoch nicht ab.

Parameter

NameTypBeschreibung
timeoutInSecondsIntegerDie Zeit in Sekunden, die auf die Ausführung von Daten gewartet werden soll. Das Maximum beträgt 300 Sekunden.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets