Доступ и изменение существующего источника данных. Чтобы создать таблицу источника данных с новым источником данных, см. DataSourceTable
.
Используйте этот класс только с данными, подключенными к базе данных.
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
cancelAllLinkedDataSourceObjectRefreshes() | void | Отменяет все текущие обновления объектов источника данных, связанных с этим источником данных. |
createCalculatedColumn(name, formula) | DataSourceColumn | Создает вычисляемый столбец. |
createDataSourcePivotTableOnNewSheet() | DataSourcePivotTable | Создает сводную таблицу источника данных из этого источника данных в первой ячейке нового листа. |
createDataSourceTableOnNewSheet() | DataSourceTable | Создает таблицу источника данных из этого источника данных в первой ячейке нового листа. |
getCalculatedColumnByName(columnName) | DataSourceColumn | Возвращает вычисляемый столбец в источнике данных, соответствующий имени столбца. |
getCalculatedColumns() | DataSourceColumn[] | Возвращает все вычисляемые столбцы в источнике данных. |
getColumns() | DataSourceColumn[] | Возвращает все столбцы в источнике данных. |
getDataSourceSheets() | DataSourceSheet[] | Возвращает листы источника данных, связанные с этим источником данных. |
getSpec() | DataSourceSpec | Получает спецификацию источника данных. |
refreshAllLinkedDataSourceObjects() | void | Обновляет все объекты источника данных, связанные с источником данных. |
updateSpec(spec) | DataSource | Обновляет спецификацию источника данных и обновляет объекты источника данных, связанные с этим источником данных, с использованием новой спецификации. |
updateSpec(spec, refreshAllLinkedObjects) | DataSource | Обновляет спецификацию источника данных и обновляет связанные data source sheets с использованием новой спецификации. |
waitForAllDataExecutionsCompletion(timeoutInSeconds) | void | Ожидает завершения всех текущих выполнений связанных объектов источника данных, а время ожидания истекает через указанное количество секунд. |
Подробная документация
cancelAllLinkedDataSourceObjectRefreshes()
Отменяет все текущие обновления объектов источника данных, связанных с этим источником данных.
В этом примере показано, как отменить все обновления источника данных.
SpreadsheetApp.enableBigQueryExecution(); const dataSource = spreadsheet.getDataSources()[0]; dataSource.cancelAllLinkedDataSourceObjectRefreshes();
Выдает исключение, если тип источника данных не включен. Используйте методы SpreadsheetApp#enable...Execution()
чтобы включить выполнение данных для определенного типа источника данных.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
createCalculatedColumn(name, formula)
Создает вычисляемый столбец.
Параметры
Имя | Тип | Описание |
---|---|---|
name | String | Имя вычисляемого столбца. |
formula | String | Формула вычисляемого столбца. |
Возвращаться
DataSourceColumn
— вновь созданный вычисляемый столбец.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
createDataSourcePivotTableOnNewSheet()
Создает сводную таблицу источника данных из этого источника данных в первой ячейке нового листа. В качестве побочного эффекта новый лист становится активным.
Возвращаться
DataSourcePivotTable
— вновь созданная сводная таблица источника данных.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
createDataSourceTableOnNewSheet()
Создает таблицу источника данных из этого источника данных в первой ячейке нового листа. В качестве побочного эффекта новый лист становится активным.
Возвращаться
DataSourceTable
— вновь созданная таблица источника данных.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getCalculatedColumnByName(columnName)
Возвращает вычисляемый столбец в источнике данных, соответствующий имени столбца.
Параметры
Имя | Тип | Описание |
---|---|---|
columnName | String | Имя вычисляемого столбца, который нужно получить. |
Возвращаться
DataSourceColumn
— вычисляемый столбец, соответствующий имени столбца, или null
, если такого вычисляемого столбца нет.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getCalculatedColumns()
Возвращает все вычисляемые столбцы в источнике данных.
Возвращаться
DataSourceColumn[]
— Массив всех вычисляемых столбцов в источнике данных.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumns()
Возвращает все столбцы в источнике данных.
Возвращаться
DataSourceColumn[]
— Массив всех DataSourceColumn
в источнике данных.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceSheets()
Возвращает листы источника данных, связанные с этим источником данных.
Возвращаться
DataSourceSheet[]
— Массив листов источников данных.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSpec()
Получает спецификацию источника данных.
Возвращаться
DataSourceSpec
— Спецификация источника данных.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
refreshAllLinkedDataSourceObjects()
Обновляет все объекты источника данных, связанные с источником данных.
Выдает исключение, если тип источника данных не включен. Используйте методы SpreadsheetApp#enable...Execution()
чтобы включить выполнение данных для определенного типа источника данных.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
updateSpec(spec)
Обновляет спецификацию источника данных и обновляет объекты источника данных, связанные с этим источником данных, с использованием новой спецификации.
Выдает исключение, если тип источника данных не включен. Используйте методы SpreadsheetApp#enable...Execution()
чтобы включить выполнение данных для определенного типа источника данных.
Параметры
Имя | Тип | Описание |
---|---|---|
spec | DataSourceSpec | Спецификация источника данных для обновления. |
Возвращаться
DataSource
— источник данных.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
updateSpec(spec, refreshAllLinkedObjects)
Обновляет спецификацию источника данных и обновляет связанные data source sheets
с учетом новой спецификации.
Выдает исключение, если тип источника данных не включен. Используйте методы SpreadsheetApp#enable...Execution()
чтобы включить выполнение данных для определенного типа источника данных.
Параметры
Имя | Тип | Описание |
---|---|---|
spec | DataSourceSpec | Спецификация источника данных для обновления. |
refreshAllLinkedObjects | Boolean | Если true , также обновляются все объекты источника данных, связанные с этим источником данных. |
Возвращаться
DataSource
— источник данных.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
waitForAllDataExecutionsCompletion(timeoutInSeconds)
Ожидает завершения всех текущих выполнений связанных объектов источника данных, а время ожидания истекает через указанное количество секунд. Вызывает исключение, если выполнение не завершается по истечении времени ожидания, но не отменяет выполнение данных.
Параметры
Имя | Тип | Описание |
---|---|---|
timeoutInSeconds | Integer | Время ожидания выполнения данных в секундах. Максимум — 300 секунд. |
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets