Class DataSource

Datenquelle

Auf vorhandene 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()voidAlle derzeit laufenden Aktualisierungen von Datenquellenobjekten, die mit dieser Datenquelle verknüpft sind, werden abgebrochen.
createCalculatedColumn(name, formula)DataSourceColumnErstellt eine berechnete Spalte.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableHiermit wird in der ersten Zelle eines neuen Tabellenblatts eine Pivot-Tabelle für die Datenquelle erstellt.
createDataSourceTableOnNewSheet()DataSourceTableHiermit wird in der ersten Zelle eines neuen Tabellenblatts eine Datenquellentabelle aus dieser Datenquelle erstellt.
getCalculatedColumnByName(columnName)DataSourceColumnGibt 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[]Die mit dieser Datenquelle verknüpften Datenquellenblätter werden zurückgegeben.
getSpec()DataSourceSpecRuft die Datenquellenspezifikation ab.
refreshAllLinkedDataSourceObjects()voidAlle mit der Datenquelle verknüpften Datenquellenobjekte 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üpfte data source sheets mit der neuen Spezifikation.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidWartet, bis alle aktuellen Ausführungen der verknüpften Datenquellenobjekte abgeschlossen sind. Nach der angegebenen Anzahl von Sekunden tritt eine Zeitüberschreitung auf.

Detaillierte Dokumentation

cancelAllLinkedDataSourceObjectRefreshes()

Alle derzeit laufenden Aktualisierungen von Datenquellenobjekten, die mit dieser Datenquelle verknüpft sind, werden abgebrochen.

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 Datenausführung für den jeweiligen Datenquellentyp zu aktivieren.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

createDataSourcePivotTableOnNewSheet()

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

Rückflug

DataSourcePivotTable: Die neu erstellte Datenquellen-Pivot-Tabelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

createDataSourceTableOnNewSheet()

Hiermit wird in der ersten Zelle eines neuen Tabellenblatts eine Datenquellentabelle aus dieser Datenquelle erstellt. Als Nebeneffekt wird die neue Tabelle zur aktiven Tabelle.

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

Rückflug

DataSourceTable: Die neu erstellte Datenquellentabelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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: Die berechnete Spalte, die mit dem Spaltennamen übereinstimmt, oder null, wenn es keine solche berechnete Spalte gibt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getCalculatedColumns()

Gibt alle berechneten Spalten in der Datenquelle zurück.

Bei Datenquellenspezifikationen vom Typ DataSourceType.LOOKER wird ein leeres Array zurückgegeben.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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 aller DataSourceColumn in der Datenquelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getDataSourceSheets()

Die mit dieser Datenquelle verknüpften Datenquellenblätter werden zurückgegeben.

Rückflug

DataSourceSheet[]: ein Array von Tabellen mit Datenquellen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getSpec()

Ruft die Datenquellenspezifikation ab.

Rückflug

DataSourceSpec: Datenquellenspezifikation.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

refreshAllLinkedDataSourceObjects()

Alle mit der Datenquelle verknüpften Datenquellenobjekte werden aktualisiert.

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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 Datenausführung für den jeweiligen Datenquellentyp zu aktivieren.

Es wird eine Ausnahme ausgelöst, wenn der Typ der Datenquellenspezifikation nicht mit dem aktuellen Datenquellentyp übereinstimmt.

Parameter

NameTypBeschreibung
specDataSourceSpecDie Datenquellenspezifikation, mit der die Daten aktualisiert werden sollen.

Rückflug

DataSource: Datenquelle

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

updateSpec(spec, refreshAllLinkedObjects)

Aktualisiert die Datenquellenspezifikation und aktualisiert die verknüpfte 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 Datenausführung für den jeweiligen Datenquellentyp zu aktivieren.

Es wird eine Ausnahme ausgelöst, wenn der Typ der Datenquellenspezifikation nicht mit dem aktuellen Datenquellentyp übereinstimmt.

Parameter

NameTypBeschreibung
specDataSourceSpecDie Datenquellenspezifikation, mit der die Daten aktualisiert werden sollen.
refreshAllLinkedObjectsBooleanWenn true, werden auch alle mit dieser Datenquelle verknüpften Datenquellenobjekte aktualisiert.

Rückflug

DataSource: Datenquelle

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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. Nach der angegebenen Anzahl von Sekunden tritt eine Zeitüberschreitung auf. Es wird eine Ausnahme ausgelöst, wenn die Ausführungen bei einer Zeitüberschreitung nicht abgeschlossen sind, die Datenausführungen werden jedoch nicht abgebrochen.

Parameter

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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