Class DataSource

DataSource

Vorhandene Datenquelle aufrufen und 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 ausgeführten Aktualisierungen der Datenquellenobjekte ab, die mit dieser Datenquelle verknüpft sind.
createCalculatedColumn(name, formula)DataSourceColumnErstellt eine berechnete Spalte.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableErstellt eine Datenquellen-Pivot-Tabelle aus dieser Datenquelle in der ersten Zelle eines neuen Tabellenblatts.
createDataSourceTableOnNewSheet()DataSourceTableErstellt eine Datenquellentabelle aus dieser Datenquelle in der ersten Zelle eines neuen Tabellenblatts.
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[]Gibt die Datenquellentabellen zurück, die mit dieser Datenquelle verknüpft sind.
getSpec()DataSourceSpecRuft die Datenquellenspezifikation ab.
refreshAllLinkedDataSourceObjects()voidAktualisiert alle Datenquellenobjekte, die mit der Datenquelle verknüpft sind.
updateSpec(spec)DataSourceAktualisiert die Datenquellenspezifikation und aktualisiert die Datenquellenobjekte, die mit dieser Datenquelle verknüpft sind, mit der neuen Spezifikation.
updateSpec(spec, refreshAllLinkedObjects)DataSourceAktualisiert die Spezifikation der Datenquelle und aktualisiert die verknüpfte data source sheets mit der neuen Spezifikation.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidEs wird gewartet, 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 ausgeführten Aktualisierungen der Datenquellenobjekte ab, die mit dieser Datenquelle verknüpft sind.

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

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

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createCalculatedColumn(name, formula)

Erstellt eine berechnete Spalte.

Parameter

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

Return

DataSourceColumn: Die neu erstellte berechnete Spalte.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createDataSourcePivotTableOnNewSheet()

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

Return

DataSourcePivotTable: Die neu erstellte Pivot-Tabelle der Datenquelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createDataSourceTableOnNewSheet()

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

Return

DataSourceTable: Die neu erstellte Datenquellentabelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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.

Return

DataSourceColumn: Die berechnete Spalte, die mit dem Spaltennamen übereinstimmt, oder null, wenn keine solche berechnete Spalte vorhanden ist.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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.

Return

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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.

Return

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getDataSourceSheets()

Gibt die Datenquellentabellen zurück, die mit dieser Datenquelle verknüpft sind.

Return

DataSourceSheet[]: Ein Array von Datenquellentabellen.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getSpec()

Ruft die Datenquellenspezifikation ab.

Return

DataSourceSpec: Die Spezifikation der Datenquelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

refreshAllLinkedDataSourceObjects()

Aktualisiert alle Datenquellenobjekte, die mit der Datenquelle verknüpft sind.

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

updateSpec(spec)

Aktualisiert die Datenquellenspezifikation und aktualisiert die Datenquellenobjekte, die mit dieser Datenquelle verknüpft sind, mit der neuen Spezifikation.

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

Parameter

NameTypBeschreibung
specDataSourceSpecDie Datenquellenspezifikation, die aktualisiert werden soll.

Return

DataSource: Die Datenquelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

updateSpec(spec, refreshAllLinkedObjects)

Aktualisiert die Spezifikation der Datenquelle und aktualisiert die verknüpfte data source sheets mit der neuen Spezifikation.

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

Parameter

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

Return

DataSource: Die Datenquelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Es wird gewartet, 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 Ablauf eines Zeitlimits nicht abgeschlossen werden, bricht die Datenausführungen jedoch nicht ab.

Parameter

NameTypBeschreibung
timeoutInSecondsIntegerDie Zeit in Sekunden, die auf Datenausführungen gewartet werden soll. Maximal sind 300 Sekunden zulässig.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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