Class BigQueryDataSourceSpecBuilder

BigQueryDataSourceSpecBuilder

Компоновщик BigQueryDataSourceSpecBuilder .

Методы

Метод Тип возврата Краткое описание
build() DataSourceSpec Создает спецификацию источника данных на основе настроек этого построителя.
copy() DataSourceSpecBuilder Создает DataSourceSpecBuilder на основе настроек этого источника данных.
getDatasetId() String Получает идентификатор набора данных BigQuery.
getParameters() DataSourceParameter[] Получает параметры источника данных.
getProjectId() String Получает идентификатор проекта выставления счетов.
getRawQuery() String Получает необработанную строку запроса.
getTableId() String Получает идентификатор таблицы BigQuery.
getTableProjectId() String Получает идентификатор проекта BigQuery для таблицы.
getType() DataSourceType Получает тип источника данных.
removeAllParameters() BigQueryDataSourceSpecBuilder Удаляет все параметры.
removeParameter(parameterName) BigQueryDataSourceSpecBuilder Удаляет указанный параметр.
setDatasetId(datasetId) BigQueryDataSourceSpecBuilder Устанавливает идентификатор набора данных BigQuery.
setParameterFromCell(parameterName, sourceCell) BigQueryDataSourceSpecBuilder Добавляет параметр или, если параметр с таким именем существует, обновляет его исходную ячейку для построителей спецификаций источника данных типа DataSourceType.BIGQUERY .
setProjectId(projectId) BigQueryDataSourceSpecBuilder Устанавливает идентификатор платежного проекта BigQuery.
setRawQuery(rawQuery) BigQueryDataSourceSpecBuilder Устанавливает необработанную строку запроса.
setTableId(tableId) BigQueryDataSourceSpecBuilder Устанавливает идентификатор таблицы BigQuery.
setTableProjectId(projectId) BigQueryDataSourceSpecBuilder Устанавливает идентификатор проекта BigQuery для таблицы.

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

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

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

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 — Построитель.


getDatasetId()

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

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

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


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[] — Список параметров.


getProjectId()

Получает идентификатор проекта выставления счетов.

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

String — идентификатор проекта.


getRawQuery()

Получает необработанную строку запроса.

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

String — необработанная строка запроса.


getTableId()

Получает идентификатор таблицы BigQuery.

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

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


getTableProjectId()

Получает идентификатор проекта BigQuery для таблицы.

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

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


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

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

BigQueryDataSourceSpecBuilder — построитель для цепочки.


removeParameter(parameterName)

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

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

Параметры

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

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

BigQueryDataSourceSpecBuilder — построитель для цепочки.


setDatasetId(datasetId)

Устанавливает идентификатор набора данных BigQuery.

Параметры

Имя Тип Описание
datasetId String Идентификатор набора данных.

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

BigQueryDataSourceSpecBuilder — этот построитель для создания цепочек.


setParameterFromCell(parameterName, sourceCell)

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

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

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

Параметры

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

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

BigQueryDataSourceSpecBuilder — построитель для цепочки.


setProjectId(projectId)

Устанавливает идентификатор платежного проекта BigQuery.

Параметры

Имя Тип Описание
projectId String Идентификатор платежного проекта.

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

BigQueryDataSourceSpecBuilder — построитель для цепочки.


setRawQuery(rawQuery)

Устанавливает необработанную строку запроса.

Параметры

Имя Тип Описание
rawQuery String Необработанная строка запроса.

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

BigQueryDataSourceSpecBuilder — построитель для цепочки.


setTableId(tableId)

Устанавливает идентификатор таблицы BigQuery.

Параметры

Имя Тип Описание
tableId String Идентификатор таблицы.

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

BigQueryDataSourceSpecBuilder — этот построитель для создания цепочек.


setTableProjectId(projectId)

Устанавливает идентификатор проекта BigQuery для таблицы.

Параметры

Имя Тип Описание
projectId String Идентификатор проекта таблицы BigQuery.

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

BigQueryDataSourceSpecBuilder — построитель для цепочки.