Class DataSourceSpecBuilder

DataSourceSpecBuilder

Конструктор для DataSourceSpec . Чтобы создать спецификацию для определенного типа, используйте метод as...() . Чтобы создать новый конструктор, используйте SpreadsheetApp.newDataSourceSpec() . Для использования спецификации см. DataSourceTable .

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

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

const spec = SpreadsheetApp.newDataSourceSpec()
                 .asBigQuery()
                 .setProjectId('big_query_project')
                 .setRawQuery('select @FIELD from table limit @LIMIT')
                 .setParameterFromCell('FIELD', 'Sheet1!A1')
                 .setParameterFromCell('LIMIT', 'namedRangeCell')
                 .build();

В этом примере показано, как создать спецификацию источника данных Looker. После использования build() возвращается объект LookerDataSourceSpec .

const spec = SpreadsheetApp.newDataSourceSpec()
                 .asLooker()
                 .setInstanceUrl('https://looker_instance_url.com')
                 .setModelName('model_name')
                 .setExploreName('explore_name')
                 .build();

Методы

Метод Тип возвращаемого значения Краткое описание
as Big Query() Big Query Data Source Spec Builder Получает конструктор для источника данных BigQuery.
as Looker() Looker Data Source Spec Builder Получает конструктор для источника данных Looker.
build() Data Source Spec Создает спецификацию источника данных на основе настроек этого конструктора.
copy() Data Source Spec Builder Создает Data Source Spec Builder на основе настроек этого источника данных.
get Parameters() Data Source Parameter[] Получает параметры источника данных.
get Type() Data Source Type Получает тип источника данных.
remove All Parameters() Data Source Spec Builder Удаляет все параметры.
remove Parameter(parameterName) Data Source Spec Builder Удаляет указанный параметр.
set Parameter From Cell(parameterName, sourceCell) Data Source Spec Builder Добавляет параметр или, если параметр с таким именем существует, обновляет его исходную ячейку для конструкторов спецификаций источников данных типа Data Source Type.BIGQUERY .

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

asBigQuery()

Получает конструктор для источника данных BigQuery.

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

BigQueryDataSourceSpecBuilder — конструктор спецификаций источников данных BigQuery.

asLooker()

Получает конструктор для источника данных Looker.

const spec = SpreadsheetApp.newDataSourceSpec()
                 .asLooker()
                 .setInstanceUrl('https://looker_instance_url.com')
                 .setModelName('model_name')
                 .setExploreName('explore_name')
                 .build();

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

LookerDataSourceSpecBuilder — конструктор спецификаций источников данных Looker.

build()

Создает спецификацию источника данных на основе настроек этого конструктора. Перед созданием необходимо использовать функцию as...() для указания типа источника данных.

Приведенный ниже пример кода создает спецификацию источника данных BigQuery.

const bigQueryDataSourceSpec = SpreadsheetApp.newDataSourceSpec().asBigQuery();
// TODO(developer): Replace with the required dataset, project and table IDs.
bigQueryDataSourceSpec.setDatasetId('my data set id');
bigQueryDataSourceSpec.setProjectId('my project id');
bigQueryDataSourceSpec.setTableId('my table id');

bigQueryDataSourceSpec.build();

Приведенный ниже пример кода создает спецификацию источника данных Looker.

const lookerDataSourceSpecBuilder =
    SpreadsheetApp.newDataSourceSpec().asLooker();
const lookerSpec = lookerDataSourceSpecBuilder.setExploreName('my explore name')
                       .setInstanceUrl('my instance url')
                       .setModelName('my model name')
                       .build();

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

DataSourceSpec — Спецификация источника данных.

copy()

Создает объект DataSourceSpecBuilder на основе настроек этого источника данных.

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
const spec = ss.getDataSources()[0].getSpec();

const newSpec = spec.copy();

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

DataSourceSpecBuilder — конструктор.

getParameters()

Получает параметры источника данных.

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
const spec = ss.getDataSources()[0].getSpec();
const parameters = spec.getParameters();

Этот метод доступен только для источников данных BigQuery.

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

DataSourceParameter[] — Список параметров.

getType()

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

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
const spec = ss.getDataSources()[0].getSpec();
const type = spec.getType();

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

DataSourceType — Тип источника данных.

removeAllParameters()

Удаляет все параметры.

const specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeAllParameters();

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

DataSourceSpecBuilder — конструктор для создания цепочек вызовов.

removeParameter(parameterName)

Удаляет указанный параметр. 

const specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeParameter('x');

Параметры

Имя Тип Описание
parameter Name String Название параметра, который нужно удалить.

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

DataSourceSpecBuilder — конструктор для создания цепочек вызовов.

setParameterFromCell(parameterName, sourceCell)

Добавляет параметр или, если параметр с таким именем существует, обновляет его исходную ячейку для построителей спецификаций источников данных типа DataSourceType.BIGQUERY .

Этот метод доступен только для источников данных BigQuery. 

const specBuilder = SpreadsheetApp.newDataSourceSpec().asBigQuery();
specBuilder.setParameterFromCell('x', 'A1');
const bigQuerySpec = specBuilder.build();

Параметры

Имя Тип Описание
parameter Name String Название параметра.
source Cell String Исходная ячейка, как указано в обозначении A1.

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

DataSourceSpecBuilder — конструктор для создания цепочек вызовов.