Class DataSourceSpecBuilder

Построитель спецификаций источников данных

Построитель Data Source Spec . Чтобы создать спецификацию для определенного типа, используйте метод as...() . Чтобы создать новый построитель, используйте Spreadsheet App.newDataSourceSpec() . Чтобы использовать спецификацию, см. Data Source Table .

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

В этом примере показано, как создать спецификацию источника данных 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. Он возвращает объект Looker Data Source Spec после использования build() .

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 .

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

as Big Query()

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

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

Big Query Data Source Spec Builder — построитель спецификаций источников данных BigQuery.

as Looker()

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

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

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

Looker Data Source Spec Builder — построитель спецификаций источников данных Looker.

build()

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

В следующем примере кода создается спецификация BigQuery DataSource.

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 DataSource.

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

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

Data Source Spec — спецификация источника данных.

copy()

Создает Data Source Spec Builder на основе настроек этого источника данных.

// 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();

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

Data Source Spec Builder — Построитель.

get Parameters()

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

// 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.

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

Data Source Parameter[] — список параметров.

get Type()

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

// 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();

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

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

remove All Parameters()

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

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

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

Data Source Spec Builder — конструктор для создания цепочек.

remove Parameter(parameterName)

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

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

Параметры

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

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

Data Source Spec Builder — конструктор для создания цепочек.

set Parameter From Cell(parameterName, sourceCell)

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

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

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

Параметры

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

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

Data Source Spec Builder — конструктор для создания цепочек.