uzyskiwać dostęp do istniejącej tabeli źródeł danych i ją modyfikować; Aby utworzyć w nowym arkuszu nową tabelę źródła danych:
użyj funkcji Spreadsheet.insertSheetWithDataSourceTable(spec)
.
Używaj tej klasy tylko w przypadku danych połączonych z bazą danych.
Z tego przykładu dowiesz się, jak utworzyć nową tabelę źródeł danych.
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());
Ten przykład pokazuje, jak edytować źródło danych.
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());
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addColumns(columnNames) | DataSourceTable | Dodaje kolumny do tabeli źródeł danych. |
addFilter(columnName, filterCriteria) | DataSourceTable | Dodaje filtr zastosowany do tabeli źródeł danych. |
addSortSpec(columnName, ascending) | DataSourceTable | Dodaje specyfikację sortowania do kolumny w tabeli źródeł danych. |
addSortSpec(columnName, sortOrder) | DataSourceTable | Dodaje specyfikację sortowania do kolumny w tabeli źródeł danych. |
cancelDataRefresh() | DataSourceTable | Anuluje odświeżanie danych powiązane z tym obiektem, jeśli jest on uruchomiony. |
forceRefreshData() | DataSourceTable | Odświeża dane tego obiektu niezależnie od bieżącego stanu. |
getColumns() | DataSourceTableColumn[] | Pobiera wszystkie kolumny źródła danych dodane do tabeli źródła danych. |
getDataSource() | DataSource | Pobiera źródło danych, z którym połączony jest obiekt. |
getFilters() | DataSourceTableFilter[] | Zwraca wszystkie filtry zastosowane do tabeli źródeł danych. |
getRange() | Range | Pobiera Range spany tabeli źródła danych. |
getRowLimit() | Integer | Zwraca limit wierszy w tabeli źródeł danych. |
getSortSpecs() | SortSpec[] | Pobiera wszystkie specyfikacje sortowania z tabeli źródeł danych. |
getStatus() | DataExecutionStatus | Pobiera stan wykonania danych obiektu. |
isSyncingAllColumns() | Boolean | Wskazuje, czy tabela źródła danych synchronizuje wszystkie kolumny w powiązanym źródle danych. |
refreshData() | DataSourceTable | Odświeża dane obiektu. |
removeAllColumns() | DataSourceTable | Usuwa wszystkie kolumny w tabeli źródeł danych. |
removeAllSortSpecs() | DataSourceTable | Usuwa wszystkie specyfikacje sortowania z tabeli źródeł danych. |
setRowLimit(rowLimit) | DataSourceTable | Aktualizuje limit wierszy w tabeli źródeł danych. |
syncAllColumns() | DataSourceTable | Zsynchronizuj wszystkie bieżące i przyszłe kolumny w powiązanym źródle danych z tabelą źródła danych. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Czekam na zakończenie bieżącego wykonania, przekracza limit czasu po podanej liczbie sekund. |
Szczegółowa dokumentacja
addColumns(columnNames)
Dodaje kolumny do tabeli źródeł danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnNames | String[] | Lista nazw kolumn do dodania. |
Powrót
DataSourceTable
– tabela źródeł danych służąca do tworzenia łańcuchów.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addFilter(columnName, filterCriteria)
Dodaje filtr zastosowany do tabeli źródeł danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny, do której chcesz zastosować ten filtr. |
filterCriteria | FilterCriteria | Kryteria filtrowania, które chcesz zastosować. |
Powrót
DataSourceTable
– tabela źródeł danych służąca do tworzenia łańcuchów.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addSortSpec(columnName, ascending)
Dodaje specyfikację sortowania do kolumny w tabeli źródeł danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny do sortowania. |
ascending | Boolean | Jeśli true , posortuj kolumnę w kolejności rosnącej; jeśli false , sortuj
wyświetlić kolumnę w kolejności malejącej. |
Powrót
DataSourceTable
– arkusz źródła danych służący do tworzenia łańcuchów.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addSortSpec(columnName, sortOrder)
Dodaje specyfikację sortowania do kolumny w tabeli źródeł danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
columnName | String | Nazwa kolumny do sortowania. |
sortOrder | SortOrder | Kolejność sortowania. |
Powrót
DataSourceTable
– arkusz źródła danych służący do tworzenia łańcuchów.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
cancelDataRefresh()
Anuluje odświeżanie danych powiązane z tym obiektem, jeśli jest on uruchomiony.
Ten przykład pokazuje, jak anulować odświeżenie formuły.
const spreadsheet = SpreadsheetApp.getActive(); const formula = spreadsheet.getDataSourceFormulas()[0]; // Cancel the ongoing refresh on the formula. formula.cancelDataRefresh();
Zgłasza wyjątek, jeśli typ źródła danych nie jest włączony. Użyj metod
SpreadsheetApp#enable...Execution()
, aby włączyć wykonywanie kodu dla określonego źródła danych
typu.
Powrót
DataSourceTable
– obiekt danych.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
Odświeża dane tego obiektu niezależnie od bieżącego stanu. Zobacz refreshData()
:
. Jeśli chcesz anulować aktualnie uruchomione odświeżanie tego obiektu, zobacz cancelDataRefresh()
.
Zgłasza wyjątek, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution()
, aby włączyć wykonywanie kodu dla określonego źródła danych
typu.
Powrót
DataSourceTable
– obiekt danych.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumns()
Pobiera wszystkie kolumny źródła danych dodane do tabeli źródła danych.
Powrót
DataSourceTableColumn[]
– lista kolumn tabeli źródeł danych.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSource()
Pobiera źródło danych, z którym połączony jest obiekt.
Powrót
DataSource
– źródło danych.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFilters()
Zwraca wszystkie filtry zastosowane do tabeli źródeł danych.
Powrót
DataSourceTableFilter[]
– tablica wszystkich filtrów zastosowanych do tabeli źródła danych.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRange()
getRowLimit()
Zwraca limit wierszy w tabeli źródeł danych.
Powrót
Integer
– limit wierszy w tabeli źródeł danych lub wartość null
, jeśli nie ustawiono limitu, a parametr
tabela używa domyślnego limitu maksymalnego takiego jak w interfejsie Arkuszy Google.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSortSpecs()
Pobiera wszystkie specyfikacje sortowania z tabeli źródeł danych.
Powrót
SortSpec[]
– lista specyfikacji sortowania.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getStatus()
Pobiera stan wykonania danych obiektu.
Powrót
DataExecutionStatus
– stan wykonania kodu.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isSyncingAllColumns()
Wskazuje, czy tabela źródła danych synchronizuje wszystkie kolumny w powiązanym źródle danych.
Powrót
Boolean
– True
, jeśli tabela źródła danych synchronizuje wszystkie kolumny w powiązanych danych
źródła lub false
w innym przypadku.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
refreshData()
Odświeża dane obiektu.
Zgłasza wyjątek, jeśli obecnie jest w stanie error
. Aby zaktualizować specyfikację, użyj polecenia DataSource#updateSpec()
. Metoda
preferowana niż forceRefreshData()
, aby zapobiec nieoczekiwanym edytowaniu źródła danych.
Zgłasza wyjątek, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution()
, aby włączyć wykonywanie kodu dla określonego źródła danych
typu.
Powrót
DataSourceTable
– obiekt danych.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeAllColumns()
Usuwa wszystkie kolumny w tabeli źródeł danych.
Powrót
DataSourceTable
– tabela źródeł danych służąca do tworzenia łańcuchów.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeAllSortSpecs()
Usuwa wszystkie specyfikacje sortowania z tabeli źródeł danych.
Powrót
DataSourceTable
– arkusz źródła danych służący do tworzenia łańcuchów.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setRowLimit(rowLimit)
Aktualizuje limit wierszy w tabeli źródeł danych. Jeśli limit wierszy wynosi null
,
a następnie zaktualizuje tabelę źródła danych, tak aby korzystała z domyślnej maksymalnej liczby wierszy dostępnej w interfejsie Arkuszy Google.
Parametry
Nazwa | Typ | Opis |
---|---|---|
rowLimit | Integer | Nowy limit wierszy w tabeli danych. Jeśli null , aktualizuje tabelę tak, aby jej używała
domyślny limit wierszy. |
Powrót
DataSourceTable
– tabela źródeł danych służąca do tworzenia łańcuchów.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
syncAllColumns()
Zsynchronizuj wszystkie bieżące i przyszłe kolumny w powiązanym źródle danych z tabelą źródła danych.
Powrót
DataSourceTable
– tabela źródeł danych służąca do tworzenia łańcuchów.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
waitForCompletion(timeoutInSeconds)
Czekam na zakończenie bieżącego wykonania, przekracza limit czasu po podanej liczbie sekund. Zgłasza wyjątek, jeśli wykonanie nie zostanie ukończone po przekroczeniu limitu czasu, ale nie anuluje i generowanie danych.
Parametry
Nazwa | Typ | Opis |
---|---|---|
timeoutInSeconds | Integer | Czas oczekiwania na wykonanie bazy danych (w sekundach). Maksymalna liczba to 300 sek. |
Powrót
DataExecutionStatus
– stan wykonania kodu.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets