Class DataSourceTable

Таблица источников данных

Доступ и изменение существующей таблицы источника данных. Чтобы создать новую таблицу источника данных на новом листе, используйте Spreadsheet.insertSheetWithDataSourceTable(spec) .

Используйте этот класс только с источниками данных BigQuery.

В этом примере показано, как создать новую таблицу источника данных.

SpreadsheetApp.enableBigQueryExecution();
const spreadsheet = SpreadsheetApp.getActive();
const 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.
const dataSheet = spreadsheet.insertSheetWithDataSourceTable(spec);
const 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(),
);

В этом примере показано, как редактировать источник данных. 

SpreadsheetApp.enableBigQueryExecution();
const dataSheet = SpreadsheetApp.getActive().getSheetByName('Data Sheet 1');
const dataSourceTable = dataSheet.getDataSourceTables()[0];
const dataSource = dataSourceTable.getDataSource();
const 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(),
);

Методы

Метод Тип возврата Краткое описание
add Columns(columnNames) Data Source Table Добавляет столбцы в таблицу источника данных.
add Filter(columnName, filterCriteria) Data Source Table Добавляет фильтр, примененный к таблице источника данных.
add Sort Spec(columnName, ascending) Data Source Table Добавляет спецификацию сортировки в столбец в таблице источника данных.
add Sort Spec(columnName, sortOrder) Data Source Table Добавляет спецификацию сортировки в столбец в таблице источника данных.
cancel Data Refresh() Data Source Table Отменяет обновление данных, связанное с этим объектом, если оно в данный момент выполняется.
force Refresh Data() Data Source Table Обновляет данные этого объекта независимо от текущего состояния.
get Columns() Data Source Table Column[] Получает все столбцы источника данных, добавленные в таблицу источника данных.
get Data Source() Data Source Получает источник данных, с которым связан объект.
get Filters() Data Source Table Filter[] Возвращает все фильтры, примененные к таблице источника данных.
get Range() Range Получает Range охватываемый этой таблицей источника данных.
get Row Limit() Integer Возвращает ограничение на количество строк для таблицы источника данных.
get Sort Specs() Sort Spec[] Получает все характеристики сортировки в таблице источника данных.
get Status() Data Execution Status Получает статус выполнения данных объекта.
is Syncing All Columns() Boolean Возвращает, синхронизирует ли таблица источника данных все столбцы в связанном источнике данных.
refresh Data() Data Source Table Обновляет данные объекта.
remove All Columns() Data Source Table Удаляет все столбцы в таблице источника данных.
remove All Sort Specs() Data Source Table Удаляет все параметры сортировки в таблице источника данных.
set Row Limit(rowLimit) Data Source Table Обновляет ограничение строк для таблицы источника данных.
sync All Columns() Data Source Table Синхронизируйте все текущие и будущие столбцы в связанном источнике данных с таблицей источника данных.
wait For Completion(timeoutInSeconds) Data Execution Status Ожидает завершения текущего выполнения, время ожидания истекает через указанное количество секунд.

Подробная документация

add Columns(columnNames)

Добавляет столбцы в таблицу источника данных.

Параметры

Имя Тип Описание
column Names String[] Список названий добавляемых столбцов.

Возвращаться

Data Source Table — таблица источника данных для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

add Filter(columnName, filterCriteria)

Добавляет фильтр, примененный к таблице источника данных.

Параметры

Имя Тип Описание
column Name String Имя столбца, к которому нужно применить этот фильтр.
filter Criteria Filter Criteria Критерии фильтра, которые следует применить.

Возвращаться

Data Source Table — таблица источника данных для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

add Sort Spec(columnName, ascending)

Добавляет спецификацию сортировки в столбец в таблице источника данных.

Параметры

Имя Тип Описание
column Name String Имя столбца для сортировки.
ascending Boolean Если true , отсортируйте столбец в порядке возрастания; если false , отсортируйте столбец в порядке убывания.

Возвращаться

Data Source Table — лист источника данных для связывания.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

add Sort Spec(columnName, sortOrder)

Добавляет спецификацию сортировки в столбец в таблице источника данных.

Параметры

Имя Тип Описание
column Name String Имя столбца для сортировки.
sort Order Sort Order Порядок сортировки.

Возвращаться

Data Source Table — лист источника данных для связывания.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

cancel Data Refresh()

Отменяет обновление данных, связанное с этим объектом, если оно в данный момент выполняется.

В этом примере показано, как отменить обновление формулы.

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

Выдает исключение, если тип источника данных не включен. Используйте методы Spreadsheet App#enable...Execution() чтобы включить выполнение данных для определенного типа источника данных.

Возвращаться

Data Source Table — объект данных.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

force Refresh Data()

Обновляет данные этого объекта независимо от текущего состояния. См refresh Data() для получения более подробной информации. Если вы хотите отменить текущее обновление этого объекта, см. раздел cancel Data Refresh() .

Выдает исключение, если тип источника данных не включен. Используйте методы Spreadsheet App#enable...Execution() чтобы включить выполнение данных для определенного типа источника данных.

Возвращаться

Data Source Table — объект данных.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

get Columns()

Получает все столбцы источника данных, добавленные в таблицу источника данных.

Возвращаться

Data Source Table Column[] — список столбцов таблицы источника данных.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

get Data Source()

Получает источник данных, с которым связан объект.

Возвращаться

Data Source — источник данных.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

get Filters()

Возвращает все фильтры, примененные к таблице источника данных.

Возвращаться

Data Source Table Filter[] — массив всех фильтров, примененных к таблице источника данных.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

get Range()

Получает Range охватываемый этой таблицей источника данных.

Возвращаться

Range — Диапазон.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

get Row Limit()

Возвращает ограничение на количество строк для таблицы источника данных.

Возвращаться

Integer — ограничение количества строк для таблицы источника данных или null , если ограничение не установлено и в таблице используется максимальный предел по умолчанию, как в пользовательском интерфейсе Google Таблиц.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

get Sort Specs()

Получает все характеристики сортировки в таблице источника данных.

Возвращаться

Sort Spec[] — список спецификаций сортировки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

get Status()

Получает статус выполнения данных объекта.

Возвращаться

Data Execution Status — статус выполнения данных.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

is Syncing All Columns()

Возвращает, синхронизирует ли таблица источника данных все столбцы в связанном источнике данных.

Возвращаться

Boolean — True , если таблица источника данных синхронизирует все столбцы в связанном источнике данных, или false в противном случае.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

refresh Data()

Обновляет данные объекта.

Выдает исключение, если в данный момент находится в состоянии error . Используйте Data Source#updateSpec() для обновления спецификации. Этот метод предпочтительнее force Refresh Data() чтобы предотвратить неожиданные изменения в источнике данных.

Выдает исключение, если тип источника данных не включен. Используйте методы Spreadsheet App#enable...Execution() чтобы включить выполнение данных для определенного типа источника данных.

Возвращаться

Data Source Table — объект данных.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

remove All Columns()

Удаляет все столбцы в таблице источника данных.

Возвращаться

Data Source Table — таблица источника данных для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

remove All Sort Specs()

Удаляет все параметры сортировки в таблице источника данных.

Возвращаться

Data Source Table — лист источника данных для связывания.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

set Row Limit(rowLimit)

Обновляет ограничение строк для таблицы источника данных. Если предоставленный лимит строк равен null , таблица источника данных обновляется, чтобы использовать максимальный лимит строк по умолчанию, как в пользовательском интерфейсе Google Sheets.

Параметры

Имя Тип Описание
row Limit Integer Новый предел строк для таблицы данных. Если null , таблица обновляется для использования ограничения строк по умолчанию.

Возвращаться

Data Source Table — таблица источника данных для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

sync All Columns()

Синхронизируйте все текущие и будущие столбцы в связанном источнике данных с таблицей источника данных.

Возвращаться

Data Source Table — таблица источника данных для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

wait For Completion(timeoutInSeconds)

Ожидает завершения текущего выполнения, время ожидания истекает через указанное количество секунд. Вызывает исключение, если выполнение не завершено по истечении времени ожидания, но не отменяет выполнение данных.

Параметры

Имя Тип Описание
timeout In Seconds Integer Время ожидания выполнения данных в секундах. Максимум — 300 секунд.

Возвращаться

Data Execution Status — статус выполнения данных.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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