Vorhandene Datenquellentabelle aufrufen und bearbeiten Wenn Sie eine neue Datenquellentabelle auf einem neuen Tabellenblatt erstellen möchten, verwenden Sie Spreadsheet.insertSheetWithDataSourceTable(spec)
.
Verwenden Sie diese Klasse nur mit Daten, die mit einer Datenbank verbunden sind.
In diesem Beispiel wird gezeigt, wie Sie eine neue Datenquellentabelle erstellen.
SpreadsheetApp.enableBigQueryExecution(); var spreadsheet = SpreadsheetApp.getActive(); var spec = SpreadsheetApp.newDataSourceSpec() .asBigQuery() .setProjectId('big_query_project') .setRawQuery('select @FIELD from table limit @LIMIT') .setParameterFromCell('FIELD', 'Sheet1!A1') .setParameterFromCell('LIMIT', 'namedRangeCell') .build(); // Starts data execution asynchronously. var dataSheet = spreadsheet.insertSheetWithDataSourceTable(spec); var dataSourceTable = dataSheet.getDataSourceTables()[0]; // waitForCompletion() blocks script execution until data execution completes. dataSourceTable.waitForCompletion(60); // Check status after execution. Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());
In diesem Beispiel wird gezeigt, wie Sie eine Datenquelle bearbeiten.
SpreadsheetApp.enableBigQueryExecution(); var dataSheet = SpreadsheetApp.getActive().getSheetByName("Data Sheet 1"); var dataSourceTable = dataSheet.getDataSourceTables()[0]; var dataSource = dataSourceTable.getDataSource(); var newSpec = dataSource.getSpec() .copy() .asBigQuery() .setRawQuery('select name from table limit 2') .removeAllParameters() .build(); // Updates data source specification and starts data execution asynchronously. dataSource.updateSpec(newSpec); // Check status during execution. Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState()); // waitForCompletion() blocks script execution until data execution completes. dataSourceTable.waitForCompletion(60); // Check status after execution. Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addColumns(columnNames) | DataSourceTable | Fügt der Datenquellentabelle Spalten hinzu. |
addFilter(columnName, filterCriteria) | DataSourceTable | Damit wird ein Filter hinzugefügt, der auf die Datenquellentabelle angewendet wird. |
addSortSpec(columnName, ascending) | DataSourceTable | Fügt einer Spalte in der Datenquellentabelle eine Sortierspezifikation hinzu. |
addSortSpec(columnName, sortOrder) | DataSourceTable | Fügt einer Spalte in der Datenquellentabelle eine Sortierspezifikation hinzu. |
cancelDataRefresh() | DataSourceTable | Bricht die mit diesem Objekt verknüpfte Datenaktualisierung ab, wenn es gerade ausgeführt wird. |
forceRefreshData() | DataSourceTable | Aktualisiert die Daten dieses Objekts unabhängig vom aktuellen Status. |
getColumns() | DataSourceTableColumn[] | Ruft alle Datenquellenspalten ab, die der Datenquellentabelle hinzugefügt wurden. |
getDataSource() | DataSource | Ruft die Datenquelle ab, mit der das Objekt verknüpft ist. |
getFilters() | DataSourceTableFilter[] | Gibt alle Filter zurück, die auf die Datenquellentabelle angewendet wurden. |
getRange() | Range | Ruft den Range ab, den diese Datenquellentabelle umfasst. |
getRowLimit() | Integer | Gibt das Zeilenlimit für die Datenquellentabelle zurück. |
getSortSpecs() | SortSpec[] | Ruft alle Sortierspezifikationen in der Datenquellentabelle ab. |
getStatus() | DataExecutionStatus | Ruft den Datenausführungsstatus des Objekts ab. |
isSyncingAllColumns() | Boolean | Gibt an, ob mit der Datenquellentabelle alle Spalten in der verknüpften Datenquelle synchronisiert werden. |
refreshData() | DataSourceTable | Aktualisiert die Daten des Objekts. |
removeAllColumns() | DataSourceTable | Entfernt alle Spalten in der Datenquellentabelle. |
removeAllSortSpecs() | DataSourceTable | Entfernt alle Sortierspezifikationen in der Datenquellentabelle. |
setRowLimit(rowLimit) | DataSourceTable | Aktualisiert das Zeilenlimit für die Datenquellentabelle. |
syncAllColumns() | DataSourceTable | Alle aktuellen und zukünftigen Spalten in der verknüpften Datenquelle mit der Datenquellentabelle synchronisieren. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Wartet, bis die aktuelle Ausführung abgeschlossen ist. Nach der angegebenen Anzahl von Sekunden wird das Zeitlimit überschritten. |
Detaillierte Dokumentation
addColumns(columnNames)
Fügt der Datenquellentabelle Spalten hinzu.
Parameter
Name | Typ | Beschreibung |
---|---|---|
columnNames | String[] | Die Liste der Namen der hinzuzufügenden Spalten. |
Return
DataSourceTable
: Die Datenquellentabelle für Verkettungen.
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
addFilter(columnName, filterCriteria)
Damit wird ein Filter hinzugefügt, der auf die Datenquellentabelle angewendet wird.
Parameter
Name | Typ | Beschreibung |
---|---|---|
columnName | String | Der Name der Spalte, auf die dieser Filter angewendet werden soll. |
filterCriteria | FilterCriteria | Die Filterkriterien, die angewendet werden sollen. |
Return
DataSourceTable
: Die Datenquellentabelle für Verkettungen.
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
addSortSpec(columnName, ascending)
Fügt einer Spalte in der Datenquellentabelle eine Sortierspezifikation hinzu.
Parameter
Name | Typ | Beschreibung |
---|---|---|
columnName | String | Der Name der Spalte, die sortiert werden soll. |
ascending | Boolean | Bei true wird die Spalte in aufsteigender Reihenfolge sortiert. Bei false wird die Spalte in absteigender Reihenfolge sortiert. |
Return
DataSourceTable
: Das Datenquellenblatt für Verkettungen.
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
addSortSpec(columnName, sortOrder)
Fügt einer Spalte in der Datenquellentabelle eine Sortierspezifikation hinzu.
Parameter
Name | Typ | Beschreibung |
---|---|---|
columnName | String | Der Name der Spalte, die sortiert werden soll. |
sortOrder | SortOrder | Die Sortierreihenfolge. |
Return
DataSourceTable
: Das Datenquellenblatt für Verkettungen.
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
cancelDataRefresh()
Bricht die mit diesem Objekt verknüpfte Datenaktualisierung ab, wenn es gerade ausgeführt wird.
In diesem Beispiel wird gezeigt, wie Sie eine Formelaktualisierung abbrechen.
const spreadsheet = SpreadsheetApp.getActive(); const formula = spreadsheet.getDataSourceFormulas()[0]; // Cancel the ongoing refresh on the formula. formula.cancelDataRefresh();
Gibt eine Ausnahme aus, wenn der Typ der Datenquelle nicht aktiviert ist. Verwenden Sie
SpreadsheetApp#enable...Execution()
-Methoden, um die Datenausführung für einen bestimmten Datenquellentyp zu aktivieren.
Return
DataSourceTable
: Das Datenobjekt.
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
forceRefreshData()
Aktualisiert die Daten dieses Objekts unabhängig vom aktuellen Status. Weitere Informationen finden Sie unter refreshData()
. Informationen zum Abbrechen einer aktuellen Aktualisierung dieses Objekts finden Sie unter cancelDataRefresh()
.
Gibt eine Ausnahme aus, wenn der Typ der Datenquelle nicht aktiviert ist. Verwenden Sie SpreadsheetApp#enable...Execution()
-Methoden, um die Datenausführung für einen bestimmten Datenquellentyp zu aktivieren.
Return
DataSourceTable
: Das Datenobjekt.
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()
Ruft alle Datenquellenspalten ab, die der Datenquellentabelle hinzugefügt wurden.
Return
DataSourceTableColumn[]
: Eine Liste der Datenquellentabellenspalten.
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
getDataSource()
Ruft die Datenquelle ab, mit der das Objekt verknüpft ist.
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
getFilters()
Gibt alle Filter zurück, die auf die Datenquellentabelle angewendet wurden.
Return
DataSourceTableFilter[]
: Ein Array aller Filter, die auf die Datenquellentabelle angewendet wurden.
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
getRange()
Ruft den Range
ab, den diese Datenquellentabelle umfasst.
Return
Range
: Der Bereich.
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
getRowLimit()
Gibt das Zeilenlimit für die Datenquellentabelle zurück.
Return
Integer
: das Zeilenlimit für die Datenquellentabelle oder null
, wenn kein Limit festgelegt ist und für die Tabelle das Standardhöchstlimit wie in der Google Tabellen-UI verwendet wird.
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
getSortSpecs()
Ruft alle Sortierspezifikationen in der Datenquellentabelle ab.
Return
SortSpec[]
: Eine Liste von Sortierspezifikationen.
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
getStatus()
Ruft den Datenausführungsstatus des Objekts ab.
Return
DataExecutionStatus
: Status der Datenausführung.
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
isSyncingAllColumns()
Gibt an, ob mit der Datenquellentabelle alle Spalten in der verknüpften Datenquelle synchronisiert werden.
Return
Boolean
: True
, wenn mit der Datenquellentabelle alle Spalten in der verknüpften Datenquelle synchronisiert werden, oder false
.
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
refreshData()
Aktualisiert die Daten des Objekts.
Löst eine Ausnahme aus, wenn sich derzeit der Status error
befindet. Verwenden Sie DataSource#updateSpec()
, um die Spezifikation zu aktualisieren. Die Methode wird gegenüber forceRefreshData()
bevorzugt, um unerwartete Änderungen an der Datenquelle zu verhindern.
Gibt eine Ausnahme aus, wenn der Typ der Datenquelle nicht aktiviert ist. Verwenden Sie SpreadsheetApp#enable...Execution()
-Methoden, um die Datenausführung für einen bestimmten Datenquellentyp zu aktivieren.
Return
DataSourceTable
: Das Datenobjekt.
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
removeAllColumns()
Entfernt alle Spalten in der Datenquellentabelle.
Return
DataSourceTable
: Die Datenquellentabelle für Verkettungen.
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
removeAllSortSpecs()
Entfernt alle Sortierspezifikationen in der Datenquellentabelle.
Return
DataSourceTable
: Das Datenquellenblatt für Verkettungen.
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
setRowLimit(rowLimit)
Aktualisiert das Zeilenlimit für die Datenquellentabelle. Wenn das angegebene Zeilenlimit null
ist, wird die Datenquellentabelle auf das standardmäßige maximale Zeilenlimit aktualisiert, wie in der Google Tabellen-UI.
Parameter
Name | Typ | Beschreibung |
---|---|---|
rowLimit | Integer | Das neue Zeilenlimit für die Datentabelle. Wenn null , wird die Tabelle auf die Verwendung des Standardzeilenlimits aktualisiert. |
Return
DataSourceTable
: Die Datenquellentabelle für Verkettungen.
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
syncAllColumns()
Alle aktuellen und zukünftigen Spalten in der verknüpften Datenquelle mit der Datenquellentabelle synchronisieren.
Return
DataSourceTable
: Die Datenquellentabelle für Verkettungen.
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
waitForCompletion(timeoutInSeconds)
Wartet, bis die aktuelle Ausführung abgeschlossen ist. Nach der angegebenen Anzahl von Sekunden wird das Zeitlimit überschritten. Löst eine Ausnahme aus, wenn die Ausführung bei Ablauf des Zeitlimits nicht abgeschlossen ist, bricht jedoch die Datenausführung nicht ab.
Parameter
Name | Typ | Beschreibung |
---|---|---|
timeoutInSeconds | Integer | Die Zeit in Sekunden, die auf die Ausführung der Daten gewartet werden soll. Maximal sind 300 Sekunden zulässig. |
Return
DataExecutionStatus
: Status der Datenausführung.
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