Class DataSource

Źródłodanych

uzyskiwać dostęp do istniejącego źródła danych i je modyfikować; Aby utworzyć tabelę źródła danych z nowym źródłem danych, zapoznaj się z artykułem DataSourceTable.

Używaj tej klasy tylko z danymi połączonymi z bazą danych.

Metody

MetodaZwracany typKrótki opis
cancelAllLinkedDataSourceObjectRefreshes()voidanuluje wszystkie obecnie wykonywane odświeżenia obiektów źródła danych połączonych z tym źródłem danych.
createCalculatedColumn(name, formula)DataSourceColumnTworzy obliczoną kolumnę.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableTworzy tabelę przestawną źródła danych z tego źródła danych w pierwszej komórce nowego arkusza.
createDataSourceTableOnNewSheet()DataSourceTableTworzy tabelę źródła danych z tego źródła danych w pierwszej komórce nowego arkusza.
getCalculatedColumnByName(columnName)DataSourceColumnZwraca obliczoną kolumnę w źródle danych, która odpowiada nazwie kolumny.
getCalculatedColumns()DataSourceColumn[]Zwraca wszystkie kolumny obliczeniowe w źródle danych.
getColumns()DataSourceColumn[]Zwraca wszystkie kolumny w źródle danych.
getDataSourceSheets()DataSourceSheet[]Zwraca arkusze źródła danych powiązane z tym źródłem danych.
getSpec()DataSourceSpecPobiera specyfikację źródła danych.
refreshAllLinkedDataSourceObjects()voidOdświeża wszystkie obiekty źródła danych połączone ze źródłem danych.
updateSpec(spec)DataSourceAktualizuje specyfikację źródła danych i odświeża obiekty źródła danych połączone z tym źródłem danych zgodnie z nową specyfikacją.
updateSpec(spec, refreshAllLinkedObjects)DataSourceZaktualizuje specyfikację źródła danych i odświeży połączone data source sheets z nową specyfikacją.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidCzeka na zakończenie wszystkich bieżących działań obiektów połączonych źródeł danych. Po upływie podanej liczby sekund następuje przekroczenie limitu czasu.

Szczegółowa dokumentacja

cancelAllLinkedDataSourceObjectRefreshes()

anuluje wszystkie obecnie wykonywane odświeżenia obiektów źródła danych połączonych z tym źródłem danych.

Ten przykład pokazuje, jak anulować wszystkie odświeżenia źródła danych. 

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

Wyjątek jest zgłaszany, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution(), aby umożliwić wykonywanie zapytań do bazy danych w przypadku konkretnego typu źródła danych.

Autoryzacja

Skrypty, które korzystają 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

createCalculatedColumn(name, formula)

Tworzy obliczoną kolumnę. Ta metoda jest dostępna tylko w przypadku źródeł danych BigQuery.

Parametry

NazwaTypOpis
nameStringNazwa kolumny obliczeniowej.
formulaStringFormuła obliczonej kolumny.

Powrót

DataSourceColumn – nowo utworzona obliczona kolumna.

Autoryzacja

Skrypty, które korzystają 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

createDataSourcePivotTableOnNewSheet()

Tworzy tabelę przestawną źródła danych z tego źródła danych w pierwszej komórce nowego arkusza. W efekcie ubocznym nowy arkusz staje się aktywnym arkuszem.

Powrót

DataSourcePivotTable – nowo utworzona tabela przestawna źródła danych.

Autoryzacja

Skrypty, które korzystają 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

createDataSourceTableOnNewSheet()

Tworzy tabelę źródła danych z tego źródła danych w pierwszej komórce nowego arkusza. W efekcie powoduje to, że nowy arkusz staje się aktywnym arkuszem.

Ta metoda jest dostępna tylko w przypadku źródeł danych BigQuery.

Powrót

DataSourceTable – nowo utworzona tabela źródła danych.

Autoryzacja

Skrypty, które korzystają 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

getCalculatedColumnByName(columnName)

Zwraca obliczoną kolumnę w źródle danych, która odpowiada nazwie kolumny.

Parametry

NazwaTypOpis
columnNameStringNazwa obliczonej kolumny, którą chcesz pobrać.

Powrót

DataSourceColumn – obliczona kolumna pasująca do nazwy kolumny lub null, jeśli takiej obliczonej kolumny nie ma.

Autoryzacja

Skrypty, które korzystają 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

getCalculatedColumns()

Zwraca wszystkie kolumny obliczeniowe w źródle danych.

Specyfikacje źródeł danych typu DataSourceType.LOOKER zwracają pusty tablice.

Powrót

DataSourceColumn[] – tablica wszystkich obliczonych kolumn w źródle danych.

Autoryzacja

Skrypty, które korzystają 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()

Zwraca wszystkie kolumny w źródle danych.

Powrót

DataSourceColumn[] – tablica wszystkich DataSourceColumn w źródle danych.

Autoryzacja

Skrypty, które korzystają 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

getDataSourceSheets()

Zwraca arkusze źródła danych powiązane z tym źródłem danych.

Powrót

DataSourceSheet[] – tablice źródła danych.

Autoryzacja

Skrypty, które korzystają 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

getSpec()

Pobiera specyfikację źródła danych.

Powrót

DataSourceSpec – specyfikacja źródła danych.

Autoryzacja

Skrypty, które korzystają 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

refreshAllLinkedDataSourceObjects()

Odświeża wszystkie obiekty źródła danych połączone ze źródłem danych.

Wyjątek jest zgłaszany, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution(), aby umożliwić wykonywanie zapytań do bazy danych w przypadku konkretnego typu źródła danych.

Autoryzacja

Skrypty, które korzystają 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

updateSpec(spec)

Aktualizuje specyfikację źródła danych i odświeża obiekty źródła danych połączone z tym źródłem danych zgodnie z nową specyfikacją.

Wyjątek jest zgłaszany, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution(), aby umożliwić wykonywanie zapytań do bazy danych w przypadku konkretnego typu źródła danych.

Wyjątek jest rzucany, jeśli typ specyfikacji źródła danych jest inny niż typ bieżącego źródła danych.

Parametry

NazwaTypOpis
specDataSourceSpecSpecyfikacja źródła danych, która ma zostać zaktualizowana.

Powrót

DataSource – źródło danych.

Autoryzacja

Skrypty, które korzystają 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

updateSpec(spec, refreshAllLinkedObjects)

Zaktualizuje specyfikację źródła danych i odświeży połączone data source sheets z nową specyfikacją.

Wyjątek jest zgłaszany, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution(), aby umożliwić wykonywanie zapytań do bazy danych w przypadku konkretnego typu źródła danych.

Wyjątek jest rzucany, jeśli typ specyfikacji źródła danych jest inny niż typ bieżącego źródła danych.

Parametry

NazwaTypOpis
specDataSourceSpecSpecyfikacja źródła danych, która ma zostać zaktualizowana.
refreshAllLinkedObjectsBooleanJeśli true, odświeża też wszystkie obiekty źródła danych połączone z tym źródłem danych.

Powrót

DataSource – źródło danych.

Autoryzacja

Skrypty, które korzystają 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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Czeka na zakończenie wszystkich bieżących działań obiektów połączonych źródeł danych. Po upływie podanej liczby sekund następuje przekroczenie limitu czasu. Wyjątek jest rzucany, jeśli wykonanie nie zostało ukończone w okresie oczekiwania, ale nie powoduje anulowania wykonania danych.

Parametry

NazwaTypOpis
timeoutInSecondsIntegerCzas oczekiwania na wykonanie zapytań do bazy danych (w sekundach). Maksymalny czas trwania to 300 sekund.

Autoryzacja

Skrypty, które korzystają 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