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|null Возвращает ограничение на количество строк в таблице источника данных.
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 — Ограничение на количество строк в таблице источника данных или null , если ограничение не установлено и таблица использует максимальное ограничение по умолчанию, как в пользовательском интерфейсе Google Sheets.

Авторизация

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

  • 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